@egret/engine 7.0.1-rc.3 → 7.0.2

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 (304) hide show
  1. package/dist/Engine.js +7 -2
  2. package/dist/animation/sequenceResetTypes.d.ts +6 -0
  3. package/dist/animation/types.d.ts +6 -0
  4. package/dist/assetBundle.d.ts +2 -0
  5. package/dist/assetGroupTypes.d.ts +2 -0
  6. package/dist/audioCues.d.ts +4 -0
  7. package/dist/audioTypes.d.ts +13 -0
  8. package/dist/bitmapButtonTypes.d.ts +2 -0
  9. package/dist/bitmapFontTypes.d.ts +3 -0
  10. package/dist/bitmapResourceSlot.d.ts +1 -0
  11. package/dist/camera2d.js +10 -2
  12. package/dist/cameraTypes.d.ts +12 -0
  13. package/dist/contentTypes.d.ts +2 -0
  14. package/dist/createEngineForProfile.js +8 -5
  15. package/dist/fontContentTypes.d.ts +5 -0
  16. package/dist/gameClockTypes.d.ts +6 -0
  17. package/dist/gameRun.d.ts +3 -0
  18. package/dist/gamepadTypes.d.ts +8 -0
  19. package/dist/hoverInputTypes.d.ts +10 -0
  20. package/dist/index.d.ts +5 -2
  21. package/dist/index.js +2 -1
  22. package/dist/inputActions.d.ts +5 -0
  23. package/dist/internal/uiFactoryState.d.ts +4 -0
  24. package/dist/internal/uiFactoryState.js +18 -2
  25. package/dist/keyboardInput.d.ts +1 -0
  26. package/dist/keyboardInput.js +1 -0
  27. package/dist/keyboardInputTypes.d.ts +12 -0
  28. package/dist/kit.d.ts +3 -1
  29. package/dist/kit.js +2 -1
  30. package/dist/manifestResourceState.d.ts +1 -0
  31. package/dist/manifestResourceState.js +1 -0
  32. package/dist/manifestResourceTypes.d.ts +1 -0
  33. package/dist/motion.d.ts +2 -0
  34. package/dist/mouseInputTypes.d.ts +4 -0
  35. package/dist/particleEmitter.js +8 -0
  36. package/dist/particleTypes.d.ts +8 -0
  37. package/dist/physics2d.d.ts +2 -2
  38. package/dist/physics2d.js +1 -1
  39. package/dist/physics2dTypes.d.ts +55 -1
  40. package/dist/physics2dWorld.js +209 -9
  41. package/dist/pointerInput.d.ts +1 -0
  42. package/dist/pointerInput.js +1 -0
  43. package/dist/pointerInputTypes.d.ts +3 -0
  44. package/dist/random.d.ts +1 -0
  45. package/dist/rendering/packSharedDraws2D.js +53 -5
  46. package/dist/rendering/prepareSharedDraws2D.d.ts +2 -0
  47. package/dist/rendering/prepareSharedDraws2D.js +17 -6
  48. package/dist/rendering/sharedColor2D.d.ts +35 -1
  49. package/dist/rendering/sharedColor2D.js +131 -8
  50. package/dist/rendering/sharedEffects2D.js +16 -8
  51. package/dist/rendering/world3d/Animation3D.d.ts +9 -0
  52. package/dist/rendering/world3d/Animation3D.js +4 -0
  53. package/dist/rendering/world3d/AnimationTexture3D.d.ts +6 -0
  54. package/dist/rendering/world3d/AnimationTexture3D.js +2 -0
  55. package/dist/rendering/world3d/Batch3D.d.ts +4 -0
  56. package/dist/rendering/world3d/Batch3D.js +3 -0
  57. package/dist/rendering/world3d/Camera3D.d.ts +5 -0
  58. package/dist/rendering/world3d/Camera3D.js +3 -0
  59. package/dist/rendering/world3d/Character3D.d.ts +4 -0
  60. package/dist/rendering/world3d/Character3D.js +2 -0
  61. package/dist/rendering/world3d/Cloth3D.d.ts +18 -3
  62. package/dist/rendering/world3d/Cloth3D.js +6 -1
  63. package/dist/rendering/world3d/Compression3D.d.ts +1 -0
  64. package/dist/rendering/world3d/Compression3D.js +1 -0
  65. package/dist/rendering/world3d/Curves3D.d.ts +8 -0
  66. package/dist/rendering/world3d/Curves3D.js +5 -0
  67. package/dist/rendering/world3d/Decal3D.d.ts +2 -0
  68. package/dist/rendering/world3d/Decal3D.js +1 -0
  69. package/dist/rendering/world3d/Export3D.d.ts +13 -0
  70. package/dist/rendering/world3d/Export3D.js +263 -0
  71. package/dist/rendering/world3d/Geometry3D.d.ts +11 -1
  72. package/dist/rendering/world3d/Geometry3D.js +10 -1
  73. package/dist/rendering/world3d/GeometryBuilder3D.d.ts +2 -0
  74. package/dist/rendering/world3d/Gizmo3D.d.ts +5 -0
  75. package/dist/rendering/world3d/Gizmo3D.js +2 -0
  76. package/dist/rendering/world3d/Gltf3D.d.ts +6 -0
  77. package/dist/rendering/world3d/Gltf3D.js +25 -5
  78. package/dist/rendering/world3d/GpuParticles3D.d.ts +2 -0
  79. package/dist/rendering/world3d/GpuParticles3D.js +1 -0
  80. package/dist/rendering/world3d/Hdr3D.d.ts +2 -0
  81. package/dist/rendering/world3d/Hdr3D.js +1 -0
  82. package/dist/rendering/world3d/Jelly3D.d.ts +2 -0
  83. package/dist/rendering/world3d/Jelly3D.js +1 -0
  84. package/dist/rendering/world3d/Ktx23D.d.ts +3 -0
  85. package/dist/rendering/world3d/Light3D.d.ts +9 -0
  86. package/dist/rendering/world3d/Light3D.js +4 -0
  87. package/dist/rendering/world3d/Material3D.d.ts +10 -0
  88. package/dist/rendering/world3d/Material3D.js +2 -0
  89. package/dist/rendering/world3d/Mesh3D.d.ts +4 -0
  90. package/dist/rendering/world3d/Mesh3D.js +16 -2
  91. package/dist/rendering/world3d/Meshopt3D.d.ts +3 -0
  92. package/dist/rendering/world3d/Meshopt3D.js +1 -0
  93. package/dist/rendering/world3d/Navigation3D.d.ts +41 -1
  94. package/dist/rendering/world3d/Navigation3D.js +74 -2
  95. package/dist/rendering/world3d/Object3D.d.ts +11 -0
  96. package/dist/rendering/world3d/Object3D.js +10 -0
  97. package/dist/rendering/world3d/Particles3D.d.ts +5 -0
  98. package/dist/rendering/world3d/Particles3D.js +3 -0
  99. package/dist/rendering/world3d/Physics3D.d.ts +14 -0
  100. package/dist/rendering/world3d/Physics3D.js +5 -0
  101. package/dist/rendering/world3d/PhysicsHull3D.d.ts +2 -0
  102. package/dist/rendering/world3d/PhysicsHull3D.js +2 -0
  103. package/dist/rendering/world3d/PhysicsMesh3D.d.ts +2 -0
  104. package/dist/rendering/world3d/PhysicsMesh3D.js +2 -0
  105. package/dist/rendering/world3d/PhysicsRemote3D.d.ts +5 -0
  106. package/dist/rendering/world3d/PhysicsRemote3D.js +2 -0
  107. package/dist/rendering/world3d/Ragdoll3D.d.ts +5 -0
  108. package/dist/rendering/world3d/Ragdoll3D.js +2 -0
  109. package/dist/rendering/world3d/Raycast3D.d.ts +3 -0
  110. package/dist/rendering/world3d/Raycast3D.js +1 -0
  111. package/dist/rendering/world3d/RenderList3D.d.ts +3 -0
  112. package/dist/rendering/world3d/RenderList3D.js +12 -0
  113. package/dist/rendering/world3d/Retarget3D.d.ts +1 -0
  114. package/dist/rendering/world3d/Rig3D.d.ts +57 -0
  115. package/dist/rendering/world3d/Rig3D.js +219 -0
  116. package/dist/rendering/world3d/Sdf3D.d.ts +181 -0
  117. package/dist/rendering/world3d/Sdf3D.js +1136 -0
  118. package/dist/rendering/world3d/SdfLod3D.d.ts +17 -0
  119. package/dist/rendering/world3d/SdfLod3D.js +56 -0
  120. package/dist/rendering/world3d/Serialize3D.d.ts +17 -0
  121. package/dist/rendering/world3d/Serialize3D.js +22 -0
  122. package/dist/rendering/world3d/Simplify3D.d.ts +29 -0
  123. package/dist/rendering/world3d/Simplify3D.js +426 -0
  124. package/dist/rendering/world3d/StateMachine3D.d.ts +9 -0
  125. package/dist/rendering/world3d/StateMachine3D.js +3 -0
  126. package/dist/rendering/world3d/SurfaceMaterial3D.d.ts +26 -0
  127. package/dist/rendering/world3d/SurfaceMaterial3D.js +138 -0
  128. package/dist/rendering/world3d/Terrain3D.d.ts +21 -0
  129. package/dist/rendering/world3d/Terrain3D.js +25 -1
  130. package/dist/rendering/world3d/Text3D.d.ts +5 -0
  131. package/dist/rendering/world3d/Text3D.js +2 -0
  132. package/dist/rendering/world3d/Texture3D.d.ts +16 -1
  133. package/dist/rendering/world3d/Texture3D.js +19 -1
  134. package/dist/rendering/world3d/Trail3D.d.ts +3 -0
  135. package/dist/rendering/world3d/Trail3D.js +2 -0
  136. package/dist/rendering/world3d/Vehicle3D.d.ts +5 -0
  137. package/dist/rendering/world3d/Vehicle3D.js +2 -0
  138. package/dist/rendering/world3d/VolumetricFog3D.d.ts +2 -0
  139. package/dist/rendering/world3d/VolumetricFog3D.js +1 -0
  140. package/dist/rendering/world3d/Water3D.d.ts +2 -0
  141. package/dist/rendering/world3d/Water3D.js +1 -0
  142. package/dist/rendering/world3d/core3D.d.ts +2 -0
  143. package/dist/rendering/world3d/debug3D.d.ts +5 -0
  144. package/dist/rendering/world3d/debug3D.js +5 -0
  145. package/dist/rendering/world3d/geometries3D.d.ts +12 -0
  146. package/dist/rendering/world3d/geometries3D.js +5 -0
  147. package/dist/rendering/world3d/helpers3D.d.ts +2 -0
  148. package/dist/rendering/world3d/helpers3D.js +1 -0
  149. package/dist/rendering/world3d/index.d.ts +12 -0
  150. package/dist/rendering/world3d/index.js +6 -0
  151. package/dist/rendering/world3d/math3D.d.ts +36 -0
  152. package/dist/rendering/world3d/math3D.js +35 -0
  153. package/dist/rendering/world3d/primitives3D.d.ts +7 -0
  154. package/dist/rendering/world3d/primitives3D.js +1 -0
  155. package/dist/saveStore.d.ts +18 -3
  156. package/dist/saveStore.js +23 -4
  157. package/dist/semanticList.d.ts +4 -0
  158. package/dist/semanticList.js +1 -0
  159. package/dist/semanticTree.js +11 -4
  160. package/dist/semanticTypes.d.ts +8 -0
  161. package/dist/sequencePlaybackTypes.d.ts +3 -0
  162. package/dist/text.d.ts +1 -0
  163. package/dist/textTable.d.ts +41 -0
  164. package/dist/textTable.js +114 -0
  165. package/dist/tilemapTypes.d.ts +13 -0
  166. package/dist/timer.d.ts +34 -0
  167. package/dist/timer.js +119 -0
  168. package/dist/tweenTypes.d.ts +4 -0
  169. package/dist/ui/controlKeys.d.ts +4 -0
  170. package/dist/ui/controlKeys.js +1 -0
  171. package/dist/ui/controls.d.ts +6 -0
  172. package/dist/ui/controls.js +2 -0
  173. package/dist/ui/layerTypes.d.ts +7 -0
  174. package/dist/ui/rangeControl.d.ts +3 -0
  175. package/dist/ui/rangeControl.js +1 -0
  176. package/dist/ui/scrollControl.d.ts +12 -0
  177. package/dist/ui/scrollControl.js +5 -1
  178. package/dist/ui/stateControls.d.ts +8 -0
  179. package/dist/ui/stateControls.js +3 -0
  180. package/dist/ui/textEditor.d.ts +1 -0
  181. package/dist/ui/textEditor.js +1 -0
  182. package/dist/ui/textEditorTypes.d.ts +7 -0
  183. package/dist/ui/textFieldControl.d.ts +4 -0
  184. package/dist/ui/textFieldControl.js +1 -0
  185. package/dist/ui/theme.d.ts +5 -0
  186. package/dist/ui/theme.js +1 -0
  187. package/dist/ui/types.d.ts +20 -0
  188. package/dist/ui/uiRoot.js +38 -9
  189. package/dist/ui/uiRootModel.d.ts +3 -1
  190. package/dist/ui/uiRootModel.js +8 -2
  191. package/dist/videoTypes.d.ts +3 -0
  192. package/dist/web/BrowserAssetBundle.d.ts +2 -0
  193. package/dist/web/BrowserAudio.d.ts +34 -1
  194. package/dist/web/BrowserAudio.js +69 -39
  195. package/dist/web/BrowserFrameLoop.d.ts +4 -0
  196. package/dist/web/BrowserGame.d.ts +64 -2
  197. package/dist/web/BrowserGame.js +129 -8
  198. package/dist/web/BrowserGamepadInput.d.ts +3 -0
  199. package/dist/web/BrowserHoverInput.d.ts +1 -0
  200. package/dist/web/BrowserImageTextures.d.ts +6 -0
  201. package/dist/web/BrowserInputActions.d.ts +10 -0
  202. package/dist/web/BrowserInputActions.js +4 -1
  203. package/dist/web/BrowserPlay.d.ts +130 -2
  204. package/dist/web/BrowserPlay.js +366 -19
  205. package/dist/web/BrowserPreferences.d.ts +10 -0
  206. package/dist/web/BrowserPreferences.js +39 -0
  207. package/dist/web/BrowserSemantics.d.ts +2 -0
  208. package/dist/web/BrowserStatsPanel.d.ts +10 -0
  209. package/dist/web/BrowserStatsPanel.js +9 -3
  210. package/dist/web/BrowserStorage.d.ts +2 -0
  211. package/dist/web/BrowserTextEditor.d.ts +3 -0
  212. package/dist/web/BrowserTextInput.d.ts +6 -0
  213. package/dist/web/BrowserTextureProvider.d.ts +6 -0
  214. package/dist/web/BrowserVideo.d.ts +13 -1
  215. package/dist/web/BrowserVideo.js +28 -2
  216. package/dist/web/CanvasKitFontSetProvider.d.ts +3 -0
  217. package/dist/web/CanvasKitParagraphProvider.d.ts +4 -0
  218. package/dist/web/CanvasKitParagraphProvider.js +1 -0
  219. package/dist/web/ManifestByteSource.d.ts +4 -0
  220. package/dist/web/ManifestByteSource.js +1 -0
  221. package/dist/web/ManifestFontContentLoader.d.ts +1 -0
  222. package/dist/web/WebGL2Host.js +64 -25
  223. package/dist/web/WebGPUHost.d.ts +13 -0
  224. package/dist/web/WebGPUHost.js +117 -36
  225. package/dist/web/audio.d.ts +2 -2
  226. package/dist/web/audio.js +1 -1
  227. package/dist/web/editorFonts.d.ts +4 -0
  228. package/dist/web/game.d.ts +1 -1
  229. package/dist/web/imageProjections2D.d.ts +2 -0
  230. package/dist/web/kit.d.ts +1 -0
  231. package/dist/web/kit.js +1 -0
  232. package/dist/web/play.d.ts +6 -1
  233. package/dist/web/play.js +4 -1
  234. package/dist/web/playMusic.d.ts +33 -0
  235. package/dist/web/playMusic.js +194 -0
  236. package/dist/web/playTouch.d.ts +45 -0
  237. package/dist/web/playTouch.js +141 -0
  238. package/dist/web/playWidgets.d.ts +71 -0
  239. package/dist/web/playWidgets.js +431 -0
  240. package/dist/web/prepareSharedSubmission2D.js +9 -3
  241. package/dist/web/resources.d.ts +2 -0
  242. package/dist/web/sharedEffectShaders.d.ts +6 -2
  243. package/dist/web/sharedEffectShaders.js +23 -7
  244. package/dist/web/sharedSubmissionStorage2D.js +1 -1
  245. package/dist/web/sharedWebGL2Options.d.ts +3 -0
  246. package/dist/web/sharedWebGL2Options.js +8 -2
  247. package/dist/web/sharedWebGL2Shaders.d.ts +15 -2
  248. package/dist/web/sharedWebGL2Shaders.js +108 -14
  249. package/dist/web/sharedWebGPUOptions.d.ts +5 -1
  250. package/dist/web/sharedWebGPUOptions.js +6 -2
  251. package/dist/web/video.d.ts +1 -1
  252. package/dist/web/webgl2Native.d.ts +3 -1
  253. package/dist/web/webgl2Native.js +9 -5
  254. package/dist/web/webgl2Types.d.ts +18 -0
  255. package/dist/web/webgpuImageResidency.d.ts +5 -2
  256. package/dist/web/webgpuImageResidency.js +7 -3
  257. package/dist/web/webgpuRetentionPool.d.ts +2 -2
  258. package/dist/web/webgpuRetentionPool.js +2 -1
  259. package/dist/web/webgpuSharedPass.d.ts +1 -1
  260. package/dist/web/webgpuSharedPass.js +87 -5
  261. package/dist/web/webgpuSharedResolvePass.d.ts +1 -1
  262. package/dist/web/webgpuSharedResolvePass.js +9 -4
  263. package/dist/web/world3d/Audio3D.d.ts +18 -1
  264. package/dist/web/world3d/Audio3D.js +62 -3
  265. package/dist/web/world3d/BrowserPlay3D.d.ts +115 -2
  266. package/dist/web/world3d/BrowserPlay3D.js +448 -43
  267. package/dist/web/world3d/FlyControls3D.d.ts +4 -0
  268. package/dist/web/world3d/FlyControls3D.js +2 -0
  269. package/dist/web/world3d/FollowControls3D.d.ts +3 -0
  270. package/dist/web/world3d/FollowControls3D.js +2 -0
  271. package/dist/web/world3d/OrbitControls3D.d.ts +3 -0
  272. package/dist/web/world3d/OrbitControls3D.js +2 -0
  273. package/dist/web/world3d/TransformControls3D.d.ts +5 -2
  274. package/dist/web/world3d/TransformControls3D.js +7 -4
  275. package/dist/web/world3d/WebGL2Renderer3D.d.ts +3 -0
  276. package/dist/web/world3d/WebGL2Renderer3D.js +2 -0
  277. package/dist/web/world3d/WebGPURenderer3D.d.ts +2 -0
  278. package/dist/web/world3d/WebGPURenderer3D.js +1 -0
  279. package/dist/web/world3d/World3DView.d.ts +3 -0
  280. package/dist/web/world3d/World3DView.js +2 -0
  281. package/dist/web/world3d/app3D.d.ts +7 -0
  282. package/dist/web/world3d/app3D.js +1 -0
  283. package/dist/web/world3d/assets3D.d.ts +1 -0
  284. package/dist/web/world3d/atmosphere3D.d.ts +9 -0
  285. package/dist/web/world3d/atmosphere3D.js +19 -4
  286. package/dist/web/world3d/canvasFont3D.d.ts +21 -0
  287. package/dist/web/world3d/canvasFont3D.js +165 -0
  288. package/dist/web/world3d/frame3D.d.ts +2 -0
  289. package/dist/web/world3d/host3D.d.ts +1 -0
  290. package/dist/web/world3d/index.d.ts +4 -2
  291. package/dist/web/world3d/index.js +2 -1
  292. package/dist/web/world3d/loaders3D.d.ts +1 -0
  293. package/dist/web/world3d/markers3D.d.ts +4 -0
  294. package/dist/web/world3d/overlay3D.d.ts +19 -0
  295. package/dist/web/world3d/overlay3D.js +21 -4
  296. package/dist/web/world3d/post3D.d.ts +4 -0
  297. package/dist/web/world3d/post3D.js +3 -0
  298. package/dist/web/world3d/probe3D.d.ts +1 -0
  299. package/dist/web/world3d/stats3D.d.ts +3 -0
  300. package/dist/web/world3d/stats3D.js +1 -0
  301. package/dist/web/world3d/webGL2FrameMetrics3D.d.ts +5 -0
  302. package/dist/web/world3d/webgpu.d.ts +2 -0
  303. package/dist/web/world3d/webgpu.js +1 -0
  304. package/package.json +3 -3
@@ -15,9 +15,10 @@ export { captureCubeTexture3D } from './probe3D.js';
15
15
  export { TransformControls3D, createTransformControls3D } from './TransformControls3D.js';
16
16
  export { FollowControls3D, createFollowControls3D } from './FollowControls3D.js';
17
17
  export { Atmosphere3D, createAtmosphere3D } from './atmosphere3D.js';
18
+ export { createCanvasFont3D } from './canvasFont3D.js';
18
19
  export { WORLD3D_QUALITY_PRESETS, createDynamicResolution3D, createWorld3DApp, pickWorld3DBackend, pickWorld3DQuality, isSoftwareRendered3D } from './app3D.js';
19
20
  export { createScreenMarkers3D } from './markers3D.js';
20
21
  export { createWorld3DStats } from './stats3D.js';
21
22
  export { createWorld3DOverlay } from './overlay3D.js';
22
- export { play3d, PlayThing3D } from './BrowserPlay3D.js';
23
+ export { play3d, PlayThing3D, PlayLamp3D, PLAY_LOOKS_3D } from './BrowserPlay3D.js';
23
24
  //# sourceMappingURL=index.js.map
@@ -2,6 +2,7 @@ import type { GltfAsset3D, GltfLoadOptions3D } from '../../rendering/world3d/Glt
2
2
  import type { Ktx2Options3D } from '../../rendering/world3d/Ktx23D.js';
3
3
  import { CubeTexture3D, Texture3D } from '../../rendering/world3d/Texture3D.js';
4
4
  import type { TextureOptions3D } from '../../rendering/world3d/Texture3D.js';
5
+ /** How a 3D asset is loaded: a signal that cancels it, and the most bytes it reads. */
5
6
  export interface LoadOptions3D {
6
7
  readonly signal?: AbortSignal;
7
8
  /** Upper bound for one downloaded file, in bytes. Defaults to 256 MiB. */
@@ -1,6 +1,7 @@
1
1
  import type { Camera3D } from '../../rendering/world3d/Camera3D.js';
2
2
  import type { Object3D } from '../../rendering/world3d/Object3D.js';
3
3
  import type { ViewportPoint3D } from '../../rendering/world3d/GeometryBuilder3D.js';
4
+ /** A screen marker to add: what it points at, its offset, whether it sticks to the screen's edge, and how far it shows. */
4
5
  export interface ScreenMarkerOptions3D {
5
6
  /** What the element follows: a node's world position, or a fixed world point. */
6
7
  readonly target: Object3D | readonly [number, number, number];
@@ -12,6 +13,7 @@ export interface ScreenMarkerOptions3D {
12
13
  /** Hide the element beyond this distance from the camera. */
13
14
  readonly maxDistance?: number;
14
15
  }
16
+ /** A marker over the screen that follows a point of the scene: its element and where it is. */
15
17
  export interface ScreenMarker3D {
16
18
  readonly element: HTMLElement;
17
19
  /** Where the element was placed last; `onEdge` when it was clamped. */
@@ -24,11 +26,13 @@ export interface ScreenMarker3D {
24
26
  /** Takes the marker off; the element is removed from its container when the layer added it. */
25
27
  dispose(): void;
26
28
  }
29
+ /** Screen markers to make: the container they go in, and the camera they follow. */
27
30
  export interface ScreenMarkersOptions3D {
28
31
  /** The element markers are placed in; it should cover the canvas and have `position: relative` or similar. */
29
32
  readonly container: HTMLElement;
30
33
  readonly camera: Camera3D;
31
34
  }
35
+ /** Elements over the screen that follow points of the scene: add them, and update them each frame. */
32
36
  export interface ScreenMarkers3D {
33
37
  readonly markers: readonly ScreenMarker3D[];
34
38
  /** The camera markers are projected through; may be replaced. */
@@ -1,4 +1,5 @@
1
1
  import type { BrowserGame, BrowserGameBackend } from '../game.js';
2
+ /** A 2D overlay to make over a 3D view: its size, backend, pixel ratio, update, and whether it lets input through. */
2
3
  export interface World3DOverlayOptions {
3
4
  /** The stage size, in the interface's own units. */
4
5
  readonly width: number;
@@ -10,13 +11,31 @@ export interface World3DOverlayOptions {
10
11
  /** One step of the interface, called before each 2D frame. */
11
12
  readonly update?: (deltaSeconds: number) => void;
12
13
  readonly onError?: (error: unknown) => void;
14
+ /** How translucent interface draws mix: `linear` light unless given, or the stored `srgb` codes, as a 2D canvas does. */
15
+ readonly blendSpace?: 'linear' | 'srgb';
13
16
  /** Send presses on empty parts of the interface to the 3D canvas. On by default. */
14
17
  readonly passThrough?: boolean;
18
+ /**
19
+ * How the stage of `width` × `height` is laid over the 3D canvas when their shapes differ, as a phone turns:
20
+ * `stretch` (the default) fills the canvas and squashes the interface; `contain` keeps its shape, as large as fits,
21
+ * centred, with the scene showing at the sides; `cover` keeps its shape and fills the canvas, its edges cut off by the
22
+ * canvas's parent. Read `overlay.box` for where it is.
23
+ */
24
+ readonly fit?: 'stretch' | 'contain' | 'cover';
15
25
  }
26
+ /** A 2D game drawn on a canvas over a 3D view. */
16
27
  export interface World3DOverlay {
17
28
  /** The 2D game on the overlay: its stage, scope, pointer, keyboard, loop and textures. */
18
29
  readonly game: BrowserGame;
19
30
  readonly canvas: HTMLCanvasElement;
31
+ /** Where the stage is now, in CSS pixels from the 3D canvas's top left corner, and its scale: CSS pixels per unit. */
32
+ readonly box: {
33
+ readonly x: number;
34
+ readonly y: number;
35
+ readonly width: number;
36
+ readonly height: number;
37
+ readonly scale: number;
38
+ };
20
39
  /** Ends the 2D game and takes the overlay canvas away. The 3D canvas is left as it was. */
21
40
  dispose(): Promise<void>;
22
41
  }
@@ -25,6 +25,10 @@ export async function createWorld3DOverlay(canvas, options) {
25
25
  throw new EgretError('WORLD3D_OVERLAY_OPTIONS_INVALID');
26
26
  if (!options || !(options.width > 0) || !(options.height > 0))
27
27
  throw new EgretError('WORLD3D_OVERLAY_OPTIONS_INVALID');
28
+ const fit = options.fit ?? 'stretch';
29
+ if (fit !== 'stretch' && fit !== 'contain' && fit !== 'cover')
30
+ throw new EgretError('WORLD3D_OVERLAY_OPTIONS_INVALID');
31
+ let placed = { x: 0, y: 0, width: 0, height: 0, scale: 0 };
28
32
  const doc = canvas.ownerDocument;
29
33
  const overlay = doc.createElement('canvas');
30
34
  overlay.className = 'egret-world3d-overlay';
@@ -33,10 +37,18 @@ export async function createWorld3DOverlay(canvas, options) {
33
37
  // The overlay follows the 3D canvas's box, wherever the page lays it out.
34
38
  const place = () => {
35
39
  const parent = canvas.parentElement.getBoundingClientRect(), box = canvas.getBoundingClientRect();
36
- overlay.style.left = `${box.left - parent.left + canvas.parentElement.scrollLeft}px`;
37
- overlay.style.top = `${box.top - parent.top + canvas.parentElement.scrollTop}px`;
38
- overlay.style.width = `${box.width}px`;
39
- overlay.style.height = `${box.height}px`;
40
+ let width = box.width, height = box.height;
41
+ if (fit !== 'stretch' && width > 0 && height > 0) {
42
+ const wide = width / options.width, tall = height / options.height, scale = fit === 'contain' ? Math.min(wide, tall) : Math.max(wide, tall);
43
+ width = options.width * scale;
44
+ height = options.height * scale;
45
+ }
46
+ const x = (box.width - width) / 2, y = (box.height - height) / 2;
47
+ placed = Object.freeze({ x, y, width, height, scale: width / options.width });
48
+ overlay.style.left = `${box.left - parent.left + canvas.parentElement.scrollLeft + x}px`;
49
+ overlay.style.top = `${box.top - parent.top + canvas.parentElement.scrollTop + y}px`;
50
+ overlay.style.width = `${width}px`;
51
+ overlay.style.height = `${height}px`;
40
52
  };
41
53
  place();
42
54
  const Resize = globalThis.ResizeObserver;
@@ -53,6 +65,8 @@ export async function createWorld3DOverlay(canvas, options) {
53
65
  backend: options.backend ?? 'webgl2',
54
66
  clearColor: 0,
55
67
  clearAlpha: 0,
68
+ effects: true,
69
+ ...(options.blendSpace === undefined ? {} : { blendSpace: options.blendSpace }),
56
70
  ...(options.pixelRatio === undefined ? {} : { pixelRatio: options.pixelRatio }),
57
71
  ...(options.update ? { update: options.update } : {}),
58
72
  ...(options.onError ? { onError: options.onError } : {})
@@ -157,6 +171,9 @@ export async function createWorld3DOverlay(canvas, options) {
157
171
  return {
158
172
  game,
159
173
  canvas: overlay,
174
+ get box() {
175
+ return placed;
176
+ },
160
177
  async dispose() {
161
178
  for (const type of FORWARDED)
162
179
  win.removeEventListener(type, forward, { capture: true });
@@ -17,12 +17,14 @@ export interface CustomPost3D {
17
17
  /** Four vec4 parameters written by the application. */
18
18
  readonly uniforms: Float32Array;
19
19
  }
20
+ /** Makes a post-processing pass of your own shader. */
20
21
  export declare function createCustomPost3D(input: {
21
22
  readonly key: string;
22
23
  readonly glsl?: string;
23
24
  readonly wgsl?: string;
24
25
  readonly uniforms?: ArrayLike<number>;
25
26
  }): CustomPost3D;
27
+ /** What is done to a frame after it is drawn: bloom, antialiasing, color, vignette, ambient occlusion, depth of field and outlines. */
26
28
  export interface PostProcessSettings3D {
27
29
  /** Master switch. While false the renderer draws directly and nothing here costs anything. */
28
30
  enabled: boolean;
@@ -82,9 +84,11 @@ export declare function outlineActive3D(settings: PostProcessSettings3D): boolea
82
84
  /** Post uniform layout: a, b, flags, custom[4], outline and inverse projection. */
83
85
  export declare const POST_PARAMS_FLOATS_3D = 48;
84
86
  export declare function writePostParams3D(out: Float32Array, a: ArrayLike<number>, b: ArrayLike<number>, view: PostView3D, aoEnabled: boolean, width: number, height: number, custom?: CustomPost3D, outline?: PostProcessSettings3D): void;
87
+ /** The most bloom levels. */
85
88
  export declare const POST3D_LIMITS: Readonly<{
86
89
  readonly maxBloomLevels: 8;
87
90
  }>;
91
+ /** Post-processing settings with every effect off. */
88
92
  export declare function createPostProcessSettings3D(): PostProcessSettings3D;
89
93
  /** Number of bloom levels that fit the output size. */
90
94
  export declare function bloomLevelCount3D(settings: PostProcessSettings3D, width: number, height: number): number;
@@ -1,5 +1,6 @@
1
1
  import { World3DError } from '../../rendering/world3d/core3D.js';
2
2
  import { mat4Invert } from '../../rendering/world3d/math3D.js';
3
+ /** Makes a post-processing pass of your own shader. */
3
4
  export function createCustomPost3D(input) {
4
5
  if (!input || typeof input.key !== 'string' || input.key.length === 0 || /[\s|/]/.test(input.key))
5
6
  throw new World3DError('WORLD3D_INPUT_INVALID', 'post key');
@@ -44,7 +45,9 @@ export function writePostParams3D(out, a, b, view, aoEnabled, width, height, cus
44
45
  }
45
46
  out.set(view.inverseProjection, 32);
46
47
  }
48
+ /** The most bloom levels. */
47
49
  export const POST3D_LIMITS = Object.freeze({ maxBloomLevels: 8 });
50
+ /** Post-processing settings with every effect off. */
48
51
  export function createPostProcessSettings3D() {
49
52
  return {
50
53
  enabled: false,
@@ -1,6 +1,7 @@
1
1
  import type { Scene3D } from '../../rendering/world3d/Object3D.js';
2
2
  import { CubeTexture3D } from '../../rendering/world3d/Texture3D.js';
3
3
  import type { Renderer3D } from './frame3D.js';
4
+ /** How a cube is captured around a point: its size, near and far planes, and layers. */
4
5
  export interface CubeCaptureOptions3D {
5
6
  /** Edge of each face in texels. */
6
7
  readonly size?: number;
@@ -1,4 +1,5 @@
1
1
  import type { Renderer3DInfo } from './frame3D.js';
2
+ /** 3D stats to make: the container they show in, how they smooth, and how often they refresh. */
2
3
  export interface World3DStatsOptions {
3
4
  /** Where the readout is shown; nothing is shown without it. */
4
5
  readonly container?: HTMLElement;
@@ -7,6 +8,7 @@ export interface World3DStatsOptions {
7
8
  /** How often the text is rewritten, in milliseconds. Defaults to 250. */
8
9
  readonly refreshMs?: number;
9
10
  }
11
+ /** Frame times, frame rate, draws and triangles of a 3D view, measured each frame. */
10
12
  export interface World3DStats {
11
13
  /** Smoothed milliseconds: the whole frame, and each part named in `lap`. */
12
14
  readonly average: Readonly<Record<string, number>>;
@@ -25,6 +27,7 @@ export interface World3DStats {
25
27
  /** Removes the readout. */
26
28
  dispose(): void;
27
29
  }
30
+ /** Makes a panel that shows a 3D view's frame times and draws. */
28
31
  export declare function createWorld3DStats(renderer: {
29
32
  readonly info: Renderer3DInfo;
30
33
  }, options?: World3DStatsOptions): World3DStats;
@@ -3,6 +3,7 @@
3
3
  // parts of a frame, and what the renderer drew. It tells a slow device apart
4
4
  // from a slow game. The numbers are gathered whether or not they are shown.
5
5
  import { World3DError } from '../../rendering/world3d/core3D.js';
6
+ /** Makes a panel that shows a 3D view's frame times and draws. */
6
7
  export function createWorld3DStats(renderer, options = {}) {
7
8
  if (!renderer?.info)
8
9
  throw new World3DError('WORLD3D_INPUT_INVALID', 'renderer');
@@ -1,11 +1,15 @@
1
+ /** Which view a pass drew: the main one, a reflection, or offscreen. */
1
2
  export type World3DViewKind = 'main' | 'reflection' | 'offscreen';
3
+ /** What a pass drew: color, shadows, a depth prepass, an outline mask or post-processing. */
2
4
  export type World3DPassKind = 'color' | 'shadow' | 'depth-prepass' | 'outline-mask' | 'postprocess';
5
+ /** How long a pass took on the GPU, or why that is not known. */
3
6
  export type World3DGpuTiming = {
4
7
  readonly status: 'ready';
5
8
  readonly milliseconds: number;
6
9
  } | {
7
10
  readonly status: 'disabled' | 'unsupported' | 'pending' | 'unavailable' | 'disjoint' | 'context-lost';
8
11
  };
12
+ /** One pass of a frame: its view and kind, its size, its draws and triangles, and its times. */
9
13
  export interface World3DFramePass {
10
14
  readonly view: World3DViewKind;
11
15
  /** Zero-based render() call within this application frame. */
@@ -21,6 +25,7 @@ export interface World3DFramePass {
21
25
  /** Re-read after pollFrameTimings() to observe an asynchronously resolved sample. */
22
26
  readonly gpuTime: World3DGpuTiming;
23
27
  }
28
+ /** What a frame drew: its draws and triangles, its CPU time, and its passes and reflections. */
24
29
  export interface World3DFrameMetrics {
25
30
  readonly drawCalls: number;
26
31
  readonly triangles: number;
@@ -24,6 +24,8 @@ export { FollowControls3D, createFollowControls3D } from './FollowControls3D.js'
24
24
  export type { FollowControlsOptions3D } from './FollowControls3D.js';
25
25
  export { Atmosphere3D, createAtmosphere3D } from './atmosphere3D.js';
26
26
  export type { AtmosphereOptions3D } from './atmosphere3D.js';
27
+ export { createCanvasFont3D } from './canvasFont3D.js';
28
+ export type { CanvasFontOptions3D } from './canvasFont3D.js';
27
29
  export { WORLD3D_QUALITY_PRESETS, createDynamicResolution3D, createWorld3DApp, pickWorld3DBackend, pickWorld3DQuality, isSoftwareRendered3D } from './app3D.js';
28
30
  export type { DynamicResolution3D, DynamicResolutionOptions3D, World3DApp, World3DAppOptions, World3DBackend, World3DDeviceHints, World3DQuality, World3DQualityPreset, World3DShowOptions } from './app3D.js';
29
31
  export { createScreenMarkers3D } from './markers3D.js';
@@ -15,6 +15,7 @@ export { captureCubeTexture3D } from './probe3D.js';
15
15
  export { TransformControls3D, createTransformControls3D } from './TransformControls3D.js';
16
16
  export { FollowControls3D, createFollowControls3D } from './FollowControls3D.js';
17
17
  export { Atmosphere3D, createAtmosphere3D } from './atmosphere3D.js';
18
+ export { createCanvasFont3D } from './canvasFont3D.js';
18
19
  export { WORLD3D_QUALITY_PRESETS, createDynamicResolution3D, createWorld3DApp, pickWorld3DBackend, pickWorld3DQuality, isSoftwareRendered3D } from './app3D.js';
19
20
  export { createScreenMarkers3D } from './markers3D.js';
20
21
  export { createWorld3DStats } from './stats3D.js';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@egret/engine",
3
- "version": "7.0.1-rc.3",
3
+ "version": "7.0.2",
4
4
  "type": "module",
5
5
  "exports": {
6
6
  ".": {
@@ -177,8 +177,8 @@
177
177
  }
178
178
  },
179
179
  "dependencies": {
180
- "@egret/contracts": "7.0.1-rc.3",
181
- "@egret/runtime": "7.0.1-rc.3",
180
+ "@egret/contracts": "7.0.2",
181
+ "@egret/runtime": "7.0.2",
182
182
  "robust-predicates": "3.0.3"
183
183
  },
184
184
  "imports": {