@eva/plugin-renderer-sprite 2.0.1-beta.27 → 2.0.1-beta.28

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -38,12 +38,37 @@ function __awaiter(thisArg, _arguments, P, generator) {
38
38
  });
39
39
  }
40
40
 
41
+ /**
42
+ * 精灵图组件
43
+ *
44
+ * Sprite 组件用于渲染精灵图集(Sprite Sheet)中的单个精灵。
45
+ * 它从一个包含多个小图的大图资源中提取指定的子图进行渲染,
46
+ * 这种方式可以减少纹理切换,提高渲染性能。
47
+ *
48
+ * @example
49
+ * ```typescript
50
+ * // 渲染精灵图集中的某个精灵
51
+ * const player = new GameObject('player');
52
+ * player.addComponent(new Sprite({
53
+ * resource: 'playerAtlas', // 资源名称
54
+ * spriteName: 'player_idle_01.png' // 精灵图集中的子图名称
55
+ * }));
56
+ * ```
57
+ */
41
58
  class Sprite$3 extends eva_js.Component {
42
59
  constructor() {
43
60
  super(...arguments);
61
+ /** 精灵图集资源名称 */
44
62
  this.resource = '';
63
+ /** 精灵图集中的子图名称 */
45
64
  this.spriteName = '';
46
65
  }
66
+ /**
67
+ * 初始化组件
68
+ * @param obj - 初始化参数
69
+ * @param obj.resource - 资源名称
70
+ * @param obj.spriteName - 精灵名称
71
+ */
47
72
  init(obj) {
48
73
  if (obj && obj.resource) {
49
74
  this.resource = obj.resource;
@@ -51,6 +76,7 @@ class Sprite$3 extends eva_js.Component {
51
76
  }
52
77
  }
53
78
  }
79
+ /** 组件名称 */
54
80
  Sprite$3.componentName = 'Sprite';
55
81
  __decorate([
56
82
  inspectorDecorator.type('string')
@@ -93,7 +119,7 @@ class Sprite$2 {
93
119
  }
94
120
  }
95
121
 
96
- const resourceKeySplit = '_s|r|c_';
122
+ const resourceKeySplit = '_s|r|c_'; // Notice: This key be used in ninepatch system.
97
123
  eva_js.resource.registerInstance(eva_js.RESOURCE_TYPE.SPRITE, ({ name, data }) => {
98
124
  return new Promise(r => {
99
125
  const textureObj = data.json.data;
@@ -7,10 +7,36 @@ import { RendererManager } from '@eva/plugin-renderer';
7
7
  import { RendererSystem } from '@eva/plugin-renderer';
8
8
  import { Sprite as Sprite_2 } from '@eva/renderer-adapter';
9
9
 
10
+ /**
11
+ * 精灵图组件
12
+ *
13
+ * Sprite 组件用于渲染精灵图集(Sprite Sheet)中的单个精灵。
14
+ * 它从一个包含多个小图的大图资源中提取指定的子图进行渲染,
15
+ * 这种方式可以减少纹理切换,提高渲染性能。
16
+ *
17
+ * @example
18
+ * ```typescript
19
+ * // 渲染精灵图集中的某个精灵
20
+ * const player = new GameObject('player');
21
+ * player.addComponent(new Sprite({
22
+ * resource: 'playerAtlas', // 资源名称
23
+ * spriteName: 'player_idle_01.png' // 精灵图集中的子图名称
24
+ * }));
25
+ * ```
26
+ */
10
27
  export declare class Sprite extends Component<SpriteParams> {
28
+ /** 组件名称 */
11
29
  static componentName: string;
30
+ /** 精灵图集资源名称 */
12
31
  resource: string;
32
+ /** 精灵图集中的子图名称 */
13
33
  spriteName: string;
34
+ /**
35
+ * 初始化组件
36
+ * @param obj - 初始化参数
37
+ * @param obj.resource - 资源名称
38
+ * @param obj.spriteName - 精灵名称
39
+ */
14
40
  init(obj?: SpriteParams): void;
15
41
  }
16
42
 
@@ -34,12 +34,37 @@ function __awaiter(thisArg, _arguments, P, generator) {
34
34
  });
35
35
  }
36
36
 
37
+ /**
38
+ * 精灵图组件
39
+ *
40
+ * Sprite 组件用于渲染精灵图集(Sprite Sheet)中的单个精灵。
41
+ * 它从一个包含多个小图的大图资源中提取指定的子图进行渲染,
42
+ * 这种方式可以减少纹理切换,提高渲染性能。
43
+ *
44
+ * @example
45
+ * ```typescript
46
+ * // 渲染精灵图集中的某个精灵
47
+ * const player = new GameObject('player');
48
+ * player.addComponent(new Sprite({
49
+ * resource: 'playerAtlas', // 资源名称
50
+ * spriteName: 'player_idle_01.png' // 精灵图集中的子图名称
51
+ * }));
52
+ * ```
53
+ */
37
54
  class Sprite$3 extends Component {
38
55
  constructor() {
39
56
  super(...arguments);
57
+ /** 精灵图集资源名称 */
40
58
  this.resource = '';
59
+ /** 精灵图集中的子图名称 */
41
60
  this.spriteName = '';
42
61
  }
62
+ /**
63
+ * 初始化组件
64
+ * @param obj - 初始化参数
65
+ * @param obj.resource - 资源名称
66
+ * @param obj.spriteName - 精灵名称
67
+ */
43
68
  init(obj) {
44
69
  if (obj && obj.resource) {
45
70
  this.resource = obj.resource;
@@ -47,6 +72,7 @@ class Sprite$3 extends Component {
47
72
  }
48
73
  }
49
74
  }
75
+ /** 组件名称 */
50
76
  Sprite$3.componentName = 'Sprite';
51
77
  __decorate([
52
78
  type('string')
@@ -89,7 +115,7 @@ class Sprite$2 {
89
115
  }
90
116
  }
91
117
 
92
- const resourceKeySplit = '_s|r|c_';
118
+ const resourceKeySplit = '_s|r|c_'; // Notice: This key be used in ninepatch system.
93
119
  resource.registerInstance(RESOURCE_TYPE.SPRITE, ({ name, data }) => {
94
120
  return new Promise(r => {
95
121
  const textureObj = data.json.data;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@eva/plugin-renderer-sprite",
3
- "version": "2.0.1-beta.27",
3
+ "version": "2.0.1-beta.28",
4
4
  "description": "@eva/plugin-renderer-sprite",
5
5
  "main": "index.js",
6
6
  "module": "dist/plugin-renderer-sprite.esm.js",
@@ -19,8 +19,8 @@
19
19
  "homepage": "https://eva.js.org",
20
20
  "dependencies": {
21
21
  "@eva/inspector-decorator": "^0.0.5",
22
- "@eva/plugin-renderer": "2.0.1-beta.27",
23
- "@eva/eva.js": "2.0.1-beta.27",
22
+ "@eva/plugin-renderer": "2.0.1-beta.28",
23
+ "@eva/eva.js": "2.0.1-beta.28",
24
24
  "pixi.js": "^8.8.1"
25
25
  }
26
26
  }