@galacean/engine-core 1.0.0-beta.0 → 1.0.0

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.
Files changed (98) hide show
  1. package/dist/main.js +4854 -6253
  2. package/dist/main.js.map +1 -1
  3. package/dist/miniprogram.js +4854 -6253
  4. package/dist/module.js +4850 -6245
  5. package/dist/module.js.map +1 -1
  6. package/package.json +3 -3
  7. package/types/2d/atlas/SpriteAtlas.d.ts +6 -2
  8. package/types/2d/enums/SpriteDrawMode.d.ts +2 -4
  9. package/types/2d/index.d.ts +0 -1
  10. package/types/2d/sprite/Sprite.d.ts +6 -2
  11. package/types/2d/sprite/SpriteMask.d.ts +4 -4
  12. package/types/2d/sprite/SpriteRenderer.d.ts +1 -18
  13. package/types/2d/text/Font.d.ts +7 -2
  14. package/types/2d/text/TextRenderer.d.ts +0 -4
  15. package/types/2d/text/index.d.ts +0 -1
  16. package/types/Camera.d.ts +2 -28
  17. package/types/Component.d.ts +8 -0
  18. package/types/ComponentsDependencies.d.ts +9 -17
  19. package/types/Engine.d.ts +39 -31
  20. package/types/RenderPipeline/Basic2DBatcher.d.ts +7 -6
  21. package/types/RenderPipeline/BasicRenderPipeline.d.ts +6 -8
  22. package/types/RenderPipeline/MeshRenderElement.d.ts +17 -0
  23. package/types/RenderPipeline/RenderElement.d.ts +7 -5
  24. package/types/RenderPipeline/RenderPass.d.ts +1 -1
  25. package/types/RenderPipeline/RenderQueue.d.ts +5 -3
  26. package/types/RenderPipeline/SpriteElement.d.ts +13 -0
  27. package/types/RenderPipeline/SpriteMaskBatcher.d.ts +3 -4
  28. package/types/RenderPipeline/SpriteMaskElement.d.ts +10 -0
  29. package/types/RenderPipeline/TextRenderElement.d.ts +6 -0
  30. package/types/Renderer.d.ts +2 -2
  31. package/types/Scene.d.ts +0 -2
  32. package/types/Script.d.ts +15 -18
  33. package/types/Transform.d.ts +12 -9
  34. package/types/Utils.d.ts +0 -28
  35. package/types/animation/AnimationClip.d.ts +1 -2
  36. package/types/asset/AssetType.d.ts +16 -16
  37. package/types/asset/IRefObject.d.ts +2 -0
  38. package/types/asset/{ReferResource.d.ts → RefObject.d.ts} +5 -5
  39. package/types/asset/ResourceManager.d.ts +9 -17
  40. package/types/base/Constant.d.ts +1 -2
  41. package/types/base/EngineObject.d.ts +0 -1
  42. package/types/base/Event.d.ts +24 -0
  43. package/types/base/EventDispatcher.d.ts +14 -1
  44. package/types/base/Time.d.ts +24 -27
  45. package/types/base/Util.d.ts +14 -0
  46. package/types/base/index.d.ts +2 -0
  47. package/types/graphic/Buffer.d.ts +9 -5
  48. package/types/graphic/Mesh.d.ts +5 -4
  49. package/types/index.d.ts +7 -8
  50. package/types/input/InputManager.d.ts +1 -1
  51. package/types/input/interface/IInput.d.ts +1 -1
  52. package/types/lighting/DirectLight.d.ts +1 -0
  53. package/types/lighting/SpotLight.d.ts +1 -0
  54. package/types/material/BaseMaterial.d.ts +8 -8
  55. package/types/material/Material.d.ts +7 -3
  56. package/types/mesh/BlendShape.d.ts +1 -1
  57. package/types/mesh/BlendShapeFrame.d.ts +6 -28
  58. package/types/mesh/ModelMesh.d.ts +5 -5
  59. package/types/mesh/PrimitiveMesh.d.ts +2 -4
  60. package/types/mesh/SkinnedMeshRenderer.d.ts +1 -0
  61. package/types/particle/ParticleRenderer.d.ts +2 -2
  62. package/types/physics/Collider.d.ts +1 -1
  63. package/types/physics/PhysicsManager.d.ts +20 -1
  64. package/types/physics/joint/Joint.d.ts +2 -2
  65. package/types/renderingHardwareInterface/index.d.ts +0 -1
  66. package/types/shader/Shader.d.ts +23 -32
  67. package/types/shader/ShaderData.d.ts +24 -24
  68. package/types/shader/ShaderMacro.d.ts +0 -16
  69. package/types/shader/ShaderPass.d.ts +2 -9
  70. package/types/shader/ShaderProperty.d.ts +0 -7
  71. package/types/shader/index.d.ts +1 -4
  72. package/types/shadow/CascadedShadowCasterPass.d.ts +1 -0
  73. package/types/sky/SkyBoxMaterial.d.ts +9 -30
  74. package/types/sky/index.d.ts +0 -1
  75. package/types/texture/RenderTarget.d.ts +4 -4
  76. package/types/texture/Texture.d.ts +6 -2
  77. package/types/texture/Texture2DArray.d.ts +0 -4
  78. package/types/texture/TextureCube.d.ts +0 -4
  79. package/types/2d/data/VertexData2D.d.ts +0 -1
  80. package/types/2d/enums/SpriteTileMode.d.ts +0 -11
  81. package/types/RenderPipeline/MeshRenderData.d.ts +0 -15
  82. package/types/RenderPipeline/RenderData.d.ts +0 -7
  83. package/types/RenderPipeline/SpriteMaskRenderData.d.ts +0 -10
  84. package/types/RenderPipeline/SpriteRenderData.d.ts +0 -12
  85. package/types/RenderPipeline/TextRenderData.d.ts +0 -6
  86. package/types/RenderPipeline/enums/PipelineStage.d.ts +0 -9
  87. package/types/RenderPipeline/index.d.ts +0 -4
  88. package/types/asset/ContentRestorer.d.ts +0 -17
  89. package/types/asset/GraphicsResource.d.ts +0 -9
  90. package/types/asset/IReferable.d.ts +0 -2
  91. package/types/mesh/PrimitiveMeshRestorer.d.ts +0 -1
  92. package/types/physics/Collision.d.ts +0 -4
  93. package/types/renderingHardwareInterface/IPlatformBuffer.d.ts +0 -8
  94. package/types/shader/ShaderPart.d.ts +0 -41
  95. package/types/shader/ShaderTagKey.d.ts +0 -16
  96. package/types/shader/SubShader.d.ts +0 -19
  97. package/types/sky/SkyProceduralMaterial.d.ts +0 -72
  98. /package/types/2d/{assembler/TiledSpriteAssembler.d.ts → data/RenderData2D.d.ts} +0 -0
@@ -1,46 +1,25 @@
1
- import { Color } from "@galacean/engine-math";
2
1
  import { Engine } from "../Engine";
3
2
  import { Material } from "../material/Material";
4
3
  import { TextureCube } from "../texture";
5
4
  /**
6
- * SkyBoxMaterial.
5
+ * SkyboxMaterial
7
6
  */
8
7
  export declare class SkyBoxMaterial extends Material {
9
- private static _tintColorProp;
10
- private static _textureCubeProp;
11
- private static _rotationProp;
12
- private static _exposureProp;
13
- private static _decodeSkyRGBMMacro;
14
- private _textureDecodeRGBM;
15
- private _tintColor;
8
+ private _decodeParam;
16
9
  /**
17
- * Whether to decode texture with RGBM format.
10
+ * Whether to decode from texture with RGBM format.
18
11
  */
19
12
  get textureDecodeRGBM(): boolean;
20
13
  set textureDecodeRGBM(value: boolean);
21
14
  /**
22
- * Texture of the sky box material.
15
+ * RGBM decode factor, default 5.0.
23
16
  */
24
- get texture(): TextureCube;
25
- set texture(value: TextureCube);
17
+ get RGBMDecodeFactor(): number;
18
+ set RGBMDecodeFactor(value: number);
26
19
  /**
27
- * The angle to rotate around the y-axis, unit is degree.
20
+ * Texture cube map of the sky box material.
28
21
  */
29
- get rotation(): number;
30
- set rotation(value: number);
31
- /**
32
- * The exposure value of this material.
33
- */
34
- get exposure(): number;
35
- set exposure(value: number);
36
- /**
37
- * The Tint color of this material.
38
- */
39
- get tintColor(): Color;
40
- set tintColor(value: Color);
22
+ get textureCubeMap(): TextureCube;
23
+ set textureCubeMap(v: TextureCube);
41
24
  constructor(engine: Engine);
42
- /**
43
- * @override
44
- */
45
- clone(): SkyBoxMaterial;
46
25
  }
@@ -1,3 +1,2 @@
1
1
  export { Sky } from "./Sky";
2
2
  export { SkyBoxMaterial } from "./SkyBoxMaterial";
3
- export { SkyProceduralMaterial, SunMode } from "./SkyProceduralMaterial";
@@ -1,11 +1,11 @@
1
- import { GraphicsResource } from "../asset/GraphicsResource";
1
+ import { EngineObject } from "../base";
2
2
  import { Engine } from "../Engine";
3
3
  import { RenderBufferDepthFormat } from "./enums/RenderBufferDepthFormat";
4
4
  import { Texture } from "./Texture";
5
5
  /**
6
6
  * The render target used for off-screen rendering.
7
7
  */
8
- export declare class RenderTarget extends GraphicsResource {
8
+ export declare class RenderTarget extends EngineObject {
9
9
  private _autoGenerateMipmaps;
10
10
  private _width;
11
11
  private _height;
@@ -89,7 +89,7 @@ export declare class RenderTarget extends GraphicsResource {
89
89
  */
90
90
  generateMipmaps(): void;
91
91
  /**
92
- * @override
92
+ * Destroy render target.
93
93
  */
94
- protected _onDestroy(): void;
94
+ destroy(): void;
95
95
  }
@@ -1,4 +1,4 @@
1
- import { GraphicsResource } from "../asset/GraphicsResource";
1
+ import { RefObject } from "../asset/RefObject";
2
2
  import { TextureDepthCompareFunction } from "./enums/TextureDepthCompareFunction";
3
3
  import { TextureFilterMode } from "./enums/TextureFilterMode";
4
4
  import { TextureFormat } from "./enums/TextureFormat";
@@ -6,7 +6,7 @@ import { TextureWrapMode } from "./enums/TextureWrapMode";
6
6
  /**
7
7
  * The base class of texture, contains some common functions of texture-related classes.
8
8
  */
9
- export declare abstract class Texture extends GraphicsResource {
9
+ export declare abstract class Texture extends RefObject {
10
10
  name: string;
11
11
  protected _format: TextureFormat;
12
12
  protected _width: number;
@@ -64,6 +64,10 @@ export declare abstract class Texture extends GraphicsResource {
64
64
  * Generate multi-level textures based on the 0th level data.
65
65
  */
66
66
  generateMipmaps(): void;
67
+ /**
68
+ * @override
69
+ */
70
+ _onDestroy(): void;
67
71
  /**
68
72
  * Get the maximum mip level of the corresponding size:rounding down.
69
73
  * @remarks http://download.nvidia.com/developer/Papers/2005/NP2_Mipmapping/NP2_Mipmap_Creation.pdf
@@ -78,8 +78,4 @@ export declare class Texture2DArray extends Texture {
78
78
  * @param out - Color buffer
79
79
  */
80
80
  getPixelBuffer(elementIndex: number, x: number, y: number, width: number, height: number, mipLevel: number, out: ArrayBufferView): void;
81
- /**
82
- * @override
83
- */
84
- _rebuild(): void;
85
81
  }
@@ -67,8 +67,4 @@ export declare class TextureCube extends Texture {
67
67
  * @param out - Color buffer
68
68
  */
69
69
  getPixelBuffer(face: TextureCubeFace, x: number, y: number, width: number, height: number, mipLevel: number, out: ArrayBufferView): void;
70
- /**
71
- * @override
72
- */
73
- _rebuild(): void;
74
70
  }
@@ -1 +0,0 @@
1
- export {};
@@ -1,11 +0,0 @@
1
- /**
2
- * Sprite's tiling mode enumeration.
3
- * Only works in `SpriteDrawMode.tiled` mode.
4
- */
5
- export declare enum SpriteTileMode {
6
- /** SpriteRenderer will tile continuously. */
7
- Continuous = 0,
8
- /** When the fractional part of the tiling multiple is greater than or equal to `SpriteRenderer.tileStretchValue`,
9
- * a tile will be added,and the number of tiles can only be an integer. */
10
- Adaptive = 1
11
- }
@@ -1,15 +0,0 @@
1
- import { Mesh } from "../graphic/Mesh";
2
- import { SubMesh } from "../graphic/SubMesh";
3
- import { Material } from "../material/Material";
4
- import { Renderer } from "../Renderer";
5
- import { RenderData } from "./RenderData";
6
- /**
7
- * Render element.
8
- */
9
- export declare class MeshRenderData extends RenderData {
10
- /** Mesh. */
11
- mesh: Mesh;
12
- /** Sub mesh. */
13
- subMesh: SubMesh;
14
- set(component: Renderer, material: Material, mesh: Mesh, subMesh: SubMesh): void;
15
- }
@@ -1,7 +0,0 @@
1
- import { Material } from "../material";
2
- import { Renderer } from "../Renderer";
3
- export declare class RenderData {
4
- component: Renderer;
5
- material: Material;
6
- multiRenderData: boolean;
7
- }
@@ -1,10 +0,0 @@
1
- import { VertexData2D } from "../2d/data/VertexData2D";
2
- import { Material } from "../material/Material";
3
- import { Renderer } from "../Renderer";
4
- import { RenderData } from "./RenderData";
5
- export declare class SpriteMaskRenderData extends RenderData {
6
- isAdd: boolean;
7
- verticesData: VertexData2D;
8
- constructor();
9
- set(component: Renderer, material: Material, verticesData: VertexData2D): void;
10
- }
@@ -1,12 +0,0 @@
1
- import { VertexData2D } from "../2d/data/VertexData2D";
2
- import { Material } from "../material/Material";
3
- import { Renderer } from "../Renderer";
4
- import { Texture2D } from "../texture";
5
- import { RenderData } from "./RenderData";
6
- export declare class SpriteRenderData extends RenderData {
7
- verticesData: VertexData2D;
8
- texture: Texture2D;
9
- dataIndex: number;
10
- constructor();
11
- set(component: Renderer, material: Material, verticesData: VertexData2D, texture: Texture2D, dataIndex?: number): void;
12
- }
@@ -1,6 +0,0 @@
1
- import { RenderData } from "./RenderData";
2
- import { SpriteRenderData } from "./SpriteRenderData";
3
- export declare class TextRenderData extends RenderData {
4
- charsData: SpriteRenderData[];
5
- constructor();
6
- }
@@ -1,9 +0,0 @@
1
- /**
2
- * Pipeline stage.
3
- */
4
- export declare enum PipelineStage {
5
- /** Shadow caster stage. */
6
- ShadowCaster = "ShadowCaster",
7
- /** Forward shading stage. */
8
- Forward = "Forward"
9
- }
@@ -1,4 +0,0 @@
1
- export { BasicRenderPipeline } from "./BasicRenderPipeline";
2
- export { PipelineStage } from "./enums/PipelineStage";
3
- export { RenderPass } from "./RenderPass";
4
- export { RenderQueue } from "./RenderQueue";
@@ -1,17 +0,0 @@
1
- import { EngineObject } from "../base";
2
- import { AssetPromise } from "./AssetPromise";
3
- /**
4
- * ContentRestorer is a base class for all content restore info classes.
5
- */
6
- export declare abstract class ContentRestorer<T extends EngineObject> {
7
- resource: T;
8
- /**
9
- * @param resource - The resource object of the content restorer
10
- */
11
- constructor(resource: T);
12
- /**
13
- * Restore the content of the resource.
14
- * @returns The promise of the restored content if the content is restored asynchronously, otherwise returns undefined
15
- */
16
- abstract restoreContent(): AssetPromise<T> | void;
17
- }
@@ -1,9 +0,0 @@
1
- import { Engine } from "../Engine";
2
- import { ReferResource } from "./ReferResource";
3
- export declare abstract class GraphicsResource extends ReferResource {
4
- protected constructor(engine: Engine);
5
- /**
6
- * @override
7
- */
8
- protected _onDestroy(): void;
9
- }
@@ -1,2 +0,0 @@
1
- export interface IReferable {
2
- }
@@ -1 +0,0 @@
1
- export {};
@@ -1,4 +0,0 @@
1
- import { ColliderShape } from "./shape";
2
- export declare class Collision {
3
- shape: ColliderShape;
4
- }
@@ -1,8 +0,0 @@
1
- import { SetDataOptions } from "../graphic";
2
- export interface IPlatformBuffer {
3
- bind(): void;
4
- setData(byteLength: number, data: ArrayBuffer | ArrayBufferView, bufferByteOffset?: number, dataOffset?: number, dataLength?: number, options?: SetDataOptions): void;
5
- getData(data: ArrayBufferView, bufferByteOffset?: number, dataOffset?: number, dataLength?: number): void;
6
- resize(byteLength: number): void;
7
- destroy(): void;
8
- }
@@ -1,41 +0,0 @@
1
- import { ShaderTagKey } from "./ShaderTagKey";
2
- /**
3
- * Base class for shader structure.
4
- */
5
- export declare abstract class ShaderPart {
6
- private _tagsMap;
7
- /**
8
- * Set tag by key name.
9
- * @param keyName - Key name of the tag
10
- * @param value - Tag value
11
- */
12
- setTag<T extends number | string | boolean>(keyName: string, value: T): void;
13
- /**
14
- * Set tag.
15
- * @param key - Key of the tag
16
- * @param value - Tag value
17
- */
18
- setTag<T extends number | string | boolean>(key: ShaderTagKey, value: T): void;
19
- /**
20
- * Delete a tag by key name.
21
- * @param KeyName - Key name of the tag
22
- */
23
- deleteTag(KeyName: string): void;
24
- /**
25
- * Delete a tag by key.
26
- * @param key - Key of the tag
27
- */
28
- deleteTag(key: ShaderTagKey): void;
29
- /**
30
- * Get tag by key name.
31
- * @param keyName - Key name of the tag
32
- * @returns Tag value
33
- */
34
- getTagValue<T extends number | string | boolean>(keyName: string): T;
35
- /**
36
- * Get tag value by key.
37
- * @param key - Key of the tag
38
- * @returns Tag value
39
- */
40
- getTagValue<T extends number | string | boolean>(key: ShaderTagKey): T;
41
- }
@@ -1,16 +0,0 @@
1
- /**
2
- * Shader tag key.
3
- */
4
- export declare class ShaderTagKey {
5
- private static _nameCounter;
6
- private static _nameMap;
7
- /**
8
- * Get shader property by name.
9
- * @param name - Name of the shader property
10
- * @returns Shader property
11
- */
12
- static getByName(name: string): ShaderTagKey;
13
- /** Shader tag property name. */
14
- readonly name: string;
15
- private constructor();
16
- }
@@ -1,19 +0,0 @@
1
- import { ShaderPart } from "./ShaderPart";
2
- import { ShaderPass } from "./ShaderPass";
3
- /**
4
- * Sub shader.
5
- */
6
- export declare class SubShader extends ShaderPart {
7
- readonly name: string;
8
- private _passes;
9
- /**
10
- * Sub shader passes.
11
- */
12
- get passes(): ReadonlyArray<ShaderPass>;
13
- /**
14
- * Create a sub shader.
15
- * @param name - Name of the sub shader
16
- * @param passes - Sub shader passes
17
- */
18
- constructor(name: string, passes: ShaderPass[], tags?: Record<string, number | string | boolean>);
19
- }
@@ -1,72 +0,0 @@
1
- import { Color } from "@galacean/engine-math";
2
- import { Engine } from "../Engine";
3
- import { Material } from "../material/Material";
4
- /**
5
- * Sun mode.
6
- */
7
- export declare enum SunMode {
8
- /** None */
9
- None = 0,
10
- /** Simple sun. */
11
- Simple = 1,
12
- /** High quality sun. */
13
- HighQuality = 2
14
- }
15
- /**
16
- * Sky procedural material.
17
- */
18
- export declare class SkyProceduralMaterial extends Material {
19
- private static _sunSizeProp;
20
- private static _sunSizeConvergenceProp;
21
- private static _atmosphereThicknessProp;
22
- private static _skyTintProp;
23
- private static _groundTintProp;
24
- private static _exposureProp;
25
- private static _sunHighQualityMacro;
26
- private static _sunSimpleMacro;
27
- private _sunDisk;
28
- /**
29
- * Sun mode.
30
- */
31
- get sunMode(): SunMode;
32
- set sunMode(value: SunMode);
33
- /**
34
- * Sun size, range is 0 to 1.
35
- */
36
- get sunSize(): number;
37
- set sunSize(value: number);
38
- /**
39
- * Sun size convergence, range is 0 to 20.
40
- */
41
- get sunSizeConvergence(): number;
42
- set sunSizeConvergence(value: number);
43
- /**
44
- * Atmosphere thickness, range is 0 to 5.
45
- */
46
- get atmosphereThickness(): number;
47
- set atmosphereThickness(value: number);
48
- /**
49
- * Sky tint.
50
- */
51
- get skyTint(): Color;
52
- set skyTint(value: Color);
53
- /**
54
- * Ground tint.
55
- */
56
- get groundTint(): Color;
57
- set groundTint(value: Color);
58
- /**
59
- * Exposure, range is 0 to 8.
60
- */
61
- get exposure(): number;
62
- set exposure(value: number);
63
- /**
64
- * Constructor a SkyBoxProceduralMaterial instance.
65
- * @param engine - Engine to which the material belongs
66
- */
67
- constructor(engine: Engine);
68
- /**
69
- * @override
70
- */
71
- clone(): SkyProceduralMaterial;
72
- }