@egret/engine 0.0.0-stage → 7.0.1-rc.3

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 (575) hide show
  1. package/LICENSE +201 -0
  2. package/NOTICE +21 -0
  3. package/README.md +101 -2
  4. package/README.zh-CN.md +102 -0
  5. package/dist/Engine.d.ts +77 -0
  6. package/dist/Engine.js +464 -0
  7. package/dist/animation/index.d.ts +6 -0
  8. package/dist/animation/index.js +5 -0
  9. package/dist/animation/sequenceController.d.ts +22 -0
  10. package/dist/animation/sequenceController.js +618 -0
  11. package/dist/animation/sequenceCoordinator.d.ts +26 -0
  12. package/dist/animation/sequenceCoordinator.js +161 -0
  13. package/dist/animation/sequenceInput.d.ts +25 -0
  14. package/dist/animation/sequenceInput.js +108 -0
  15. package/dist/animation/sequenceMath.d.ts +35 -0
  16. package/dist/animation/sequenceMath.js +164 -0
  17. package/dist/animation/sequenceResetSlot.d.ts +7 -0
  18. package/dist/animation/sequenceResetSlot.js +367 -0
  19. package/dist/animation/sequenceResetTypes.d.ts +42 -0
  20. package/dist/animation/sequenceResetTypes.js +2 -0
  21. package/dist/animation/types.d.ts +69 -0
  22. package/dist/animation/types.js +2 -0
  23. package/dist/assetBundle.d.ts +52 -0
  24. package/dist/assetBundle.js +173 -0
  25. package/dist/assetGroup.d.ts +17 -0
  26. package/dist/assetGroup.js +332 -0
  27. package/dist/assetGroupTypes.d.ts +15 -0
  28. package/dist/assetGroupTypes.js +2 -0
  29. package/dist/audio.d.ts +4 -0
  30. package/dist/audio.js +4 -0
  31. package/dist/audioCues.d.ts +43 -0
  32. package/dist/audioCues.js +127 -0
  33. package/dist/audioMixer.d.ts +7 -0
  34. package/dist/audioMixer.js +785 -0
  35. package/dist/audioTypes.d.ts +233 -0
  36. package/dist/audioTypes.js +3 -0
  37. package/dist/bitmapBindingTicket.d.ts +24 -0
  38. package/dist/bitmapBindingTicket.js +215 -0
  39. package/dist/bitmapButton.d.ts +4 -0
  40. package/dist/bitmapButton.js +407 -0
  41. package/dist/bitmapButtonTypes.d.ts +29 -0
  42. package/dist/bitmapButtonTypes.js +2 -0
  43. package/dist/bitmapFontParse.d.ts +10 -0
  44. package/dist/bitmapFontParse.js +246 -0
  45. package/dist/bitmapFontTypes.d.ts +109 -0
  46. package/dist/bitmapFontTypes.js +2 -0
  47. package/dist/bitmapResourceSlot.d.ts +25 -0
  48. package/dist/bitmapResourceSlot.js +340 -0
  49. package/dist/bitmapText.d.ts +6 -0
  50. package/dist/bitmapText.js +320 -0
  51. package/dist/bitmapfont.d.ts +5 -0
  52. package/dist/bitmapfont.js +5 -0
  53. package/dist/camera.d.ts +4 -0
  54. package/dist/camera.js +4 -0
  55. package/dist/camera2d.d.ts +7 -0
  56. package/dist/camera2d.js +411 -0
  57. package/dist/cameraTypes.d.ts +114 -0
  58. package/dist/cameraTypes.js +2 -0
  59. package/dist/closeHost.d.ts +4 -0
  60. package/dist/closeHost.js +66 -0
  61. package/dist/contentArtifacts.d.ts +12 -0
  62. package/dist/contentArtifacts.js +153 -0
  63. package/dist/contentAtlasPages.d.ts +13 -0
  64. package/dist/contentAtlasPages.js +117 -0
  65. package/dist/contentLoader.d.ts +6 -0
  66. package/dist/contentLoader.js +327 -0
  67. package/dist/contentTypes.d.ts +33 -0
  68. package/dist/contentTypes.js +2 -0
  69. package/dist/createEngine.d.ts +7 -0
  70. package/dist/createEngine.js +25 -0
  71. package/dist/createEngineForProfile.d.ts +5 -0
  72. package/dist/createEngineForProfile.js +42 -0
  73. package/dist/displaySubtreeTicket.d.ts +25 -0
  74. package/dist/displaySubtreeTicket.js +76 -0
  75. package/dist/fontContentLoader.d.ts +6 -0
  76. package/dist/fontContentLoader.js +298 -0
  77. package/dist/fontContentTypes.d.ts +34 -0
  78. package/dist/fontContentTypes.js +2 -0
  79. package/dist/gameClock.d.ts +24 -0
  80. package/dist/gameClock.js +246 -0
  81. package/dist/gameClockTypes.d.ts +31 -0
  82. package/dist/gameClockTypes.js +2 -0
  83. package/dist/gameRun.d.ts +50 -0
  84. package/dist/gameRun.js +97 -0
  85. package/dist/gamepad.d.ts +5 -0
  86. package/dist/gamepad.js +5 -0
  87. package/dist/gamepadInput.d.ts +4 -0
  88. package/dist/gamepadInput.js +281 -0
  89. package/dist/gamepadKeys.d.ts +4 -0
  90. package/dist/gamepadKeys.js +205 -0
  91. package/dist/gamepadTypes.d.ts +134 -0
  92. package/dist/gamepadTypes.js +3 -0
  93. package/dist/hover.d.ts +4 -0
  94. package/dist/hover.js +4 -0
  95. package/dist/hoverInput.d.ts +8 -0
  96. package/dist/hoverInput.js +503 -0
  97. package/dist/hoverInputTypes.d.ts +119 -0
  98. package/dist/hoverInputTypes.js +2 -0
  99. package/dist/index.d.ts +49 -0
  100. package/dist/index.js +20 -0
  101. package/dist/input.d.ts +6 -0
  102. package/dist/input.js +5 -0
  103. package/dist/inputActions.d.ts +81 -0
  104. package/dist/inputActions.js +330 -0
  105. package/dist/internal/contentFactoryState.d.ts +19 -0
  106. package/dist/internal/contentFactoryState.js +42 -0
  107. package/dist/internal/mouseInputFactoryState.d.ts +57 -0
  108. package/dist/internal/mouseInputFactoryState.js +125 -0
  109. package/dist/internal/sequenceControllerFactoryState.d.ts +42 -0
  110. package/dist/internal/sequenceControllerFactoryState.js +98 -0
  111. package/dist/internal/textFieldFactoryState.d.ts +11 -0
  112. package/dist/internal/textFieldFactoryState.js +32 -0
  113. package/dist/internal/texturedFrameState.d.ts +4 -0
  114. package/dist/internal/texturedFrameState.js +12 -0
  115. package/dist/internal/uiFactoryState.d.ts +64 -0
  116. package/dist/internal/uiFactoryState.js +157 -0
  117. package/dist/internal/uiRootState.d.ts +67 -0
  118. package/dist/internal/uiRootState.js +103 -0
  119. package/dist/keyboardInput.d.ts +12 -0
  120. package/dist/keyboardInput.js +578 -0
  121. package/dist/keyboardInputTypes.d.ts +81 -0
  122. package/dist/keyboardInputTypes.js +2 -0
  123. package/dist/kit.d.ts +14 -0
  124. package/dist/kit.js +9 -0
  125. package/dist/layout.d.ts +5 -0
  126. package/dist/layout.js +132 -0
  127. package/dist/layoutTypes.d.ts +28 -0
  128. package/dist/layoutTypes.js +2 -0
  129. package/dist/manifestAssetGroup.d.ts +10 -0
  130. package/dist/manifestAssetGroup.js +477 -0
  131. package/dist/manifestResourceState.d.ts +16 -0
  132. package/dist/manifestResourceState.js +57 -0
  133. package/dist/manifestResourceTypes.d.ts +25 -0
  134. package/dist/manifestResourceTypes.js +2 -0
  135. package/dist/motion.d.ts +33 -0
  136. package/dist/motion.js +206 -0
  137. package/dist/mouseInput.d.ts +102 -0
  138. package/dist/mouseInput.js +562 -0
  139. package/dist/mouseInputTypes.d.ts +37 -0
  140. package/dist/mouseInputTypes.js +2 -0
  141. package/dist/paragraph.d.ts +8 -0
  142. package/dist/paragraph.js +7 -0
  143. package/dist/particleEmitter.d.ts +4 -0
  144. package/dist/particleEmitter.js +292 -0
  145. package/dist/particleTypes.d.ts +107 -0
  146. package/dist/particleTypes.js +2 -0
  147. package/dist/particles.d.ts +4 -0
  148. package/dist/particles.js +4 -0
  149. package/dist/physics2d.d.ts +4 -0
  150. package/dist/physics2d.js +4 -0
  151. package/dist/physics2dGeometry.d.ts +39 -0
  152. package/dist/physics2dGeometry.js +230 -0
  153. package/dist/physics2dTypes.d.ts +167 -0
  154. package/dist/physics2dTypes.js +2 -0
  155. package/dist/physics2dWorld.d.ts +4 -0
  156. package/dist/physics2dWorld.js +623 -0
  157. package/dist/pointerInput.d.ts +11 -0
  158. package/dist/pointerInput.js +299 -0
  159. package/dist/pointerInputTypes.d.ts +38 -0
  160. package/dist/pointerInputTypes.js +2 -0
  161. package/dist/random.d.ts +29 -0
  162. package/dist/random.js +131 -0
  163. package/dist/rendering/ownedPreparationFailure2D.d.ts +5 -0
  164. package/dist/rendering/ownedPreparationFailure2D.js +33 -0
  165. package/dist/rendering/packSharedDraws2D.d.ts +50 -0
  166. package/dist/rendering/packSharedDraws2D.js +331 -0
  167. package/dist/rendering/packedOrientation.d.ts +4 -0
  168. package/dist/rendering/packedOrientation.js +7 -0
  169. package/dist/rendering/prepareRectangles2D.d.ts +92 -0
  170. package/dist/rendering/prepareRectangles2D.js +481 -0
  171. package/dist/rendering/prepareSharedDraws2D.d.ts +88 -0
  172. package/dist/rendering/prepareSharedDraws2D.js +652 -0
  173. package/dist/rendering/preparedBatches2D.d.ts +17 -0
  174. package/dist/rendering/preparedBatches2D.js +30 -0
  175. package/dist/rendering/preparedSharedBatches2D.d.ts +44 -0
  176. package/dist/rendering/preparedSharedBatches2D.js +247 -0
  177. package/dist/rendering/sharedColor2D.d.ts +18 -0
  178. package/dist/rendering/sharedColor2D.js +68 -0
  179. package/dist/rendering/sharedEffects2D.d.ts +23 -0
  180. package/dist/rendering/sharedEffects2D.js +118 -0
  181. package/dist/rendering/sharedPreparationRetention2D.d.ts +120 -0
  182. package/dist/rendering/sharedPreparationRetention2D.js +357 -0
  183. package/dist/rendering/srgbBytes.d.ts +3 -0
  184. package/dist/rendering/srgbBytes.js +64 -0
  185. package/dist/rendering/texturedPreparationBudget2D.d.ts +31 -0
  186. package/dist/rendering/texturedPreparationBudget2D.js +81 -0
  187. package/dist/rendering/world3d/Animation3D.d.ts +95 -0
  188. package/dist/rendering/world3d/Animation3D.js +380 -0
  189. package/dist/rendering/world3d/AnimationTexture3D.d.ts +157 -0
  190. package/dist/rendering/world3d/AnimationTexture3D.js +601 -0
  191. package/dist/rendering/world3d/Batch3D.d.ts +71 -0
  192. package/dist/rendering/world3d/Batch3D.js +329 -0
  193. package/dist/rendering/world3d/Camera3D.d.ts +57 -0
  194. package/dist/rendering/world3d/Camera3D.js +129 -0
  195. package/dist/rendering/world3d/Character3D.d.ts +123 -0
  196. package/dist/rendering/world3d/Character3D.js +303 -0
  197. package/dist/rendering/world3d/Cloth3D.d.ts +115 -0
  198. package/dist/rendering/world3d/Cloth3D.js +498 -0
  199. package/dist/rendering/world3d/Compression3D.d.ts +21 -0
  200. package/dist/rendering/world3d/Compression3D.js +702 -0
  201. package/dist/rendering/world3d/Curves3D.d.ts +111 -0
  202. package/dist/rendering/world3d/Curves3D.js +455 -0
  203. package/dist/rendering/world3d/Decal3D.d.ts +41 -0
  204. package/dist/rendering/world3d/Decal3D.js +241 -0
  205. package/dist/rendering/world3d/Geometry3D.d.ts +85 -0
  206. package/dist/rendering/world3d/Geometry3D.js +326 -0
  207. package/dist/rendering/world3d/GeometryBuilder3D.d.ts +51 -0
  208. package/dist/rendering/world3d/GeometryBuilder3D.js +196 -0
  209. package/dist/rendering/world3d/Gizmo3D.d.ts +75 -0
  210. package/dist/rendering/world3d/Gizmo3D.js +512 -0
  211. package/dist/rendering/world3d/Gltf3D.d.ts +67 -0
  212. package/dist/rendering/world3d/Gltf3D.js +976 -0
  213. package/dist/rendering/world3d/GpuParticles3D.d.ts +107 -0
  214. package/dist/rendering/world3d/GpuParticles3D.js +400 -0
  215. package/dist/rendering/world3d/Hdr3D.d.ts +33 -0
  216. package/dist/rendering/world3d/Hdr3D.js +190 -0
  217. package/dist/rendering/world3d/Jelly3D.d.ts +75 -0
  218. package/dist/rendering/world3d/Jelly3D.js +266 -0
  219. package/dist/rendering/world3d/Ktx23D.d.ts +27 -0
  220. package/dist/rendering/world3d/Ktx23D.js +112 -0
  221. package/dist/rendering/world3d/Light3D.d.ts +75 -0
  222. package/dist/rendering/world3d/Light3D.js +93 -0
  223. package/dist/rendering/world3d/Material3D.d.ts +243 -0
  224. package/dist/rendering/world3d/Material3D.js +267 -0
  225. package/dist/rendering/world3d/Mesh3D.d.ts +108 -0
  226. package/dist/rendering/world3d/Mesh3D.js +323 -0
  227. package/dist/rendering/world3d/Meshopt3D.d.ts +12 -0
  228. package/dist/rendering/world3d/Meshopt3D.js +275 -0
  229. package/dist/rendering/world3d/Navigation3D.d.ts +173 -0
  230. package/dist/rendering/world3d/Navigation3D.js +971 -0
  231. package/dist/rendering/world3d/Object3D.d.ts +107 -0
  232. package/dist/rendering/world3d/Object3D.js +305 -0
  233. package/dist/rendering/world3d/Particles3D.d.ts +85 -0
  234. package/dist/rendering/world3d/Particles3D.js +274 -0
  235. package/dist/rendering/world3d/Physics3D.d.ts +416 -0
  236. package/dist/rendering/world3d/Physics3D.js +2835 -0
  237. package/dist/rendering/world3d/PhysicsHull3D.d.ts +35 -0
  238. package/dist/rendering/world3d/PhysicsHull3D.js +227 -0
  239. package/dist/rendering/world3d/PhysicsMesh3D.d.ts +39 -0
  240. package/dist/rendering/world3d/PhysicsMesh3D.js +338 -0
  241. package/dist/rendering/world3d/PhysicsQueries3D.d.ts +24 -0
  242. package/dist/rendering/world3d/PhysicsQueries3D.js +323 -0
  243. package/dist/rendering/world3d/PhysicsRemote3D.d.ts +174 -0
  244. package/dist/rendering/world3d/PhysicsRemote3D.js +534 -0
  245. package/dist/rendering/world3d/Ragdoll3D.d.ts +69 -0
  246. package/dist/rendering/world3d/Ragdoll3D.js +200 -0
  247. package/dist/rendering/world3d/Raycast3D.d.ts +37 -0
  248. package/dist/rendering/world3d/Raycast3D.js +246 -0
  249. package/dist/rendering/world3d/RenderList3D.d.ts +88 -0
  250. package/dist/rendering/world3d/RenderList3D.js +490 -0
  251. package/dist/rendering/world3d/Retarget3D.d.ts +20 -0
  252. package/dist/rendering/world3d/Retarget3D.js +185 -0
  253. package/dist/rendering/world3d/Serialize3D.d.ts +49 -0
  254. package/dist/rendering/world3d/Serialize3D.js +607 -0
  255. package/dist/rendering/world3d/StateMachine3D.d.ts +78 -0
  256. package/dist/rendering/world3d/StateMachine3D.js +277 -0
  257. package/dist/rendering/world3d/Terrain3D.d.ts +227 -0
  258. package/dist/rendering/world3d/Terrain3D.js +803 -0
  259. package/dist/rendering/world3d/Text3D.d.ts +90 -0
  260. package/dist/rendering/world3d/Text3D.js +558 -0
  261. package/dist/rendering/world3d/Texture3D.d.ts +133 -0
  262. package/dist/rendering/world3d/Texture3D.js +252 -0
  263. package/dist/rendering/world3d/Trail3D.d.ts +59 -0
  264. package/dist/rendering/world3d/Trail3D.js +193 -0
  265. package/dist/rendering/world3d/Vehicle3D.d.ts +97 -0
  266. package/dist/rendering/world3d/Vehicle3D.js +226 -0
  267. package/dist/rendering/world3d/VolumetricFog3D.d.ts +55 -0
  268. package/dist/rendering/world3d/VolumetricFog3D.js +229 -0
  269. package/dist/rendering/world3d/Water3D.d.ts +163 -0
  270. package/dist/rendering/world3d/Water3D.js +606 -0
  271. package/dist/rendering/world3d/core3D.d.ts +34 -0
  272. package/dist/rendering/world3d/core3D.js +99 -0
  273. package/dist/rendering/world3d/debug3D.d.ts +64 -0
  274. package/dist/rendering/world3d/debug3D.js +257 -0
  275. package/dist/rendering/world3d/decoders3D.d.ts +42 -0
  276. package/dist/rendering/world3d/decoders3D.js +133 -0
  277. package/dist/rendering/world3d/geometries3D.d.ts +99 -0
  278. package/dist/rendering/world3d/geometries3D.js +605 -0
  279. package/dist/rendering/world3d/helpers3D.d.ts +65 -0
  280. package/dist/rendering/world3d/helpers3D.js +177 -0
  281. package/dist/rendering/world3d/index.d.ts +91 -0
  282. package/dist/rendering/world3d/index.js +56 -0
  283. package/dist/rendering/world3d/math3D.d.ts +78 -0
  284. package/dist/rendering/world3d/math3D.js +640 -0
  285. package/dist/rendering/world3d/primitives3D.d.ts +60 -0
  286. package/dist/rendering/world3d/primitives3D.js +196 -0
  287. package/dist/resources.d.ts +8 -0
  288. package/dist/resources.js +6 -0
  289. package/dist/saveStore.d.ts +56 -0
  290. package/dist/saveStore.js +163 -0
  291. package/dist/semanticList.d.ts +122 -0
  292. package/dist/semanticList.js +174 -0
  293. package/dist/semanticTree.d.ts +10 -0
  294. package/dist/semanticTree.js +532 -0
  295. package/dist/semanticTypes.d.ts +167 -0
  296. package/dist/semanticTypes.js +2 -0
  297. package/dist/semantics.d.ts +6 -0
  298. package/dist/semantics.js +5 -0
  299. package/dist/sequencePlayback.d.ts +19 -0
  300. package/dist/sequencePlayback.js +391 -0
  301. package/dist/sequencePlaybackTypes.d.ts +21 -0
  302. package/dist/sequencePlaybackTypes.js +2 -0
  303. package/dist/sequenceTargetClaims.d.ts +10 -0
  304. package/dist/sequenceTargetClaims.js +31 -0
  305. package/dist/srgbBytes.d.ts +3 -0
  306. package/dist/srgbBytes.js +64 -0
  307. package/dist/startEngine.d.ts +5 -0
  308. package/dist/startEngine.js +31 -0
  309. package/dist/surfaceOwnership.d.ts +3 -0
  310. package/dist/surfaceOwnership.js +15 -0
  311. package/dist/text.d.ts +23 -0
  312. package/dist/text.js +4 -0
  313. package/dist/textField.d.ts +6 -0
  314. package/dist/textField.js +6 -0
  315. package/dist/tileMapDraw.d.ts +7 -0
  316. package/dist/tileMapDraw.js +310 -0
  317. package/dist/tiledImport.d.ts +9 -0
  318. package/dist/tiledImport.js +357 -0
  319. package/dist/tilemap.d.ts +5 -0
  320. package/dist/tilemap.js +5 -0
  321. package/dist/tilemapTypes.d.ts +169 -0
  322. package/dist/tilemapTypes.js +2 -0
  323. package/dist/tween.d.ts +15 -0
  324. package/dist/tween.js +329 -0
  325. package/dist/tweenTypes.d.ts +27 -0
  326. package/dist/tweenTypes.js +2 -0
  327. package/dist/ui/controlKeys.d.ts +109 -0
  328. package/dist/ui/controlKeys.js +249 -0
  329. package/dist/ui/controls.d.ts +52 -0
  330. package/dist/ui/controls.js +288 -0
  331. package/dist/ui/editing.d.ts +3 -0
  332. package/dist/ui/editing.js +3 -0
  333. package/dist/ui/index.d.ts +19 -0
  334. package/dist/ui/index.js +11 -0
  335. package/dist/ui/keyboardFocus.d.ts +32 -0
  336. package/dist/ui/keyboardFocus.js +146 -0
  337. package/dist/ui/layerTypes.d.ts +91 -0
  338. package/dist/ui/layerTypes.js +2 -0
  339. package/dist/ui/layers.d.ts +4 -0
  340. package/dist/ui/layers.js +586 -0
  341. package/dist/ui/leafContent.d.ts +21 -0
  342. package/dist/ui/leafContent.js +136 -0
  343. package/dist/ui/rangeControl.d.ts +50 -0
  344. package/dist/ui/rangeControl.js +167 -0
  345. package/dist/ui/scrollControl.d.ts +72 -0
  346. package/dist/ui/scrollControl.js +218 -0
  347. package/dist/ui/stateControls.d.ts +82 -0
  348. package/dist/ui/stateControls.js +328 -0
  349. package/dist/ui/textEditor.d.ts +53 -0
  350. package/dist/ui/textEditor.js +370 -0
  351. package/dist/ui/textEditorTypes.d.ts +78 -0
  352. package/dist/ui/textEditorTypes.js +2 -0
  353. package/dist/ui/textFieldControl.d.ts +96 -0
  354. package/dist/ui/textFieldControl.js +259 -0
  355. package/dist/ui/theme.d.ts +59 -0
  356. package/dist/ui/theme.js +165 -0
  357. package/dist/ui/types.d.ts +265 -0
  358. package/dist/ui/types.js +2 -0
  359. package/dist/ui/uiRoot.d.ts +4 -0
  360. package/dist/ui/uiRoot.js +1497 -0
  361. package/dist/ui/uiRootDisplay.d.ts +46 -0
  362. package/dist/ui/uiRootDisplay.js +148 -0
  363. package/dist/ui/uiRootModel.d.ts +112 -0
  364. package/dist/ui/uiRootModel.js +60 -0
  365. package/dist/ui/virtualList.d.ts +20 -0
  366. package/dist/ui/virtualList.js +105 -0
  367. package/dist/video.d.ts +4 -0
  368. package/dist/video.js +4 -0
  369. package/dist/videoPlayer.d.ts +4 -0
  370. package/dist/videoPlayer.js +215 -0
  371. package/dist/videoTypes.d.ts +74 -0
  372. package/dist/videoTypes.js +2 -0
  373. package/dist/web/BrowserAssetBundle.d.ts +39 -0
  374. package/dist/web/BrowserAssetBundle.js +136 -0
  375. package/dist/web/BrowserAudio.d.ts +41 -0
  376. package/dist/web/BrowserAudio.js +473 -0
  377. package/dist/web/BrowserFrameLoop.d.ts +65 -0
  378. package/dist/web/BrowserFrameLoop.js +125 -0
  379. package/dist/web/BrowserGame.d.ts +112 -0
  380. package/dist/web/BrowserGame.js +352 -0
  381. package/dist/web/BrowserGamepadInput.d.ts +35 -0
  382. package/dist/web/BrowserGamepadInput.js +134 -0
  383. package/dist/web/BrowserHoverInput.d.ts +24 -0
  384. package/dist/web/BrowserHoverInput.js +266 -0
  385. package/dist/web/BrowserImageTextures.d.ts +66 -0
  386. package/dist/web/BrowserImageTextures.js +169 -0
  387. package/dist/web/BrowserInputActions.d.ts +53 -0
  388. package/dist/web/BrowserInputActions.js +342 -0
  389. package/dist/web/BrowserKeyboardInput.d.ts +4 -0
  390. package/dist/web/BrowserKeyboardInput.js +223 -0
  391. package/dist/web/BrowserPlay.d.ts +289 -0
  392. package/dist/web/BrowserPlay.js +1301 -0
  393. package/dist/web/BrowserPointerInput.d.ts +4 -0
  394. package/dist/web/BrowserPointerInput.js +511 -0
  395. package/dist/web/BrowserSemantics.d.ts +34 -0
  396. package/dist/web/BrowserSemantics.js +418 -0
  397. package/dist/web/BrowserStatsPanel.d.ts +46 -0
  398. package/dist/web/BrowserStatsPanel.js +137 -0
  399. package/dist/web/BrowserStorage.d.ts +33 -0
  400. package/dist/web/BrowserStorage.js +132 -0
  401. package/dist/web/BrowserTextEditor.d.ts +49 -0
  402. package/dist/web/BrowserTextEditor.js +839 -0
  403. package/dist/web/BrowserTextInput.d.ts +83 -0
  404. package/dist/web/BrowserTextInput.js +524 -0
  405. package/dist/web/BrowserTextureProvider.d.ts +52 -0
  406. package/dist/web/BrowserTextureProvider.js +935 -0
  407. package/dist/web/BrowserVideo.d.ts +28 -0
  408. package/dist/web/BrowserVideo.js +211 -0
  409. package/dist/web/CanvasKitFontSetProvider.d.ts +29 -0
  410. package/dist/web/CanvasKitFontSetProvider.js +215 -0
  411. package/dist/web/CanvasKitParagraphProvider.d.ts +169 -0
  412. package/dist/web/CanvasKitParagraphProvider.js +691 -0
  413. package/dist/web/CanvasTextRasterProvider.d.ts +4 -0
  414. package/dist/web/CanvasTextRasterProvider.js +312 -0
  415. package/dist/web/ManifestByteSource.d.ts +147 -0
  416. package/dist/web/ManifestByteSource.js +974 -0
  417. package/dist/web/ManifestFontContentLoader.d.ts +12 -0
  418. package/dist/web/ManifestFontContentLoader.js +30 -0
  419. package/dist/web/MouseInput.d.ts +4 -0
  420. package/dist/web/MouseInput.js +218 -0
  421. package/dist/web/WebGL2Host.d.ts +5 -0
  422. package/dist/web/WebGL2Host.js +2672 -0
  423. package/dist/web/WebGPUHost.d.ts +87 -0
  424. package/dist/web/WebGPUHost.js +3349 -0
  425. package/dist/web/audio.d.ts +3 -0
  426. package/dist/web/audio.js +4 -0
  427. package/dist/web/canvasKitParagraphGeometry.d.ts +27 -0
  428. package/dist/web/canvasKitParagraphGeometry.js +83 -0
  429. package/dist/web/editing.d.ts +5 -0
  430. package/dist/web/editing.js +4 -0
  431. package/dist/web/editorFonts.d.ts +50 -0
  432. package/dist/web/editorFonts.js +297 -0
  433. package/dist/web/game.d.ts +5 -0
  434. package/dist/web/game.js +6 -0
  435. package/dist/web/gamepad.d.ts +3 -0
  436. package/dist/web/gamepad.js +4 -0
  437. package/dist/web/hover.d.ts +3 -0
  438. package/dist/web/hover.js +4 -0
  439. package/dist/web/image.d.ts +4 -0
  440. package/dist/web/image.js +4 -0
  441. package/dist/web/imageProjections2D.d.ts +14 -0
  442. package/dist/web/imageProjections2D.js +2 -0
  443. package/dist/web/input.d.ts +6 -0
  444. package/dist/web/input.js +4 -0
  445. package/dist/web/keyboard.d.ts +3 -0
  446. package/dist/web/keyboard.js +3 -0
  447. package/dist/web/kit.d.ts +10 -0
  448. package/dist/web/kit.js +7 -0
  449. package/dist/web/loop.d.ts +3 -0
  450. package/dist/web/loop.js +4 -0
  451. package/dist/web/paragraph.d.ts +6 -0
  452. package/dist/web/paragraph.js +4 -0
  453. package/dist/web/play.d.ts +5 -0
  454. package/dist/web/play.js +6 -0
  455. package/dist/web/playSfx.d.ts +36 -0
  456. package/dist/web/playSfx.js +112 -0
  457. package/dist/web/pointer.d.ts +3 -0
  458. package/dist/web/pointer.js +3 -0
  459. package/dist/web/prepareSharedSubmission2D.d.ts +27 -0
  460. package/dist/web/prepareSharedSubmission2D.js +57 -0
  461. package/dist/web/resources.d.ts +27 -0
  462. package/dist/web/resources.js +96 -0
  463. package/dist/web/semantics.d.ts +3 -0
  464. package/dist/web/semantics.js +4 -0
  465. package/dist/web/sharedDeviceSession.d.ts +64 -0
  466. package/dist/web/sharedDeviceSession.js +2 -0
  467. package/dist/web/sharedEffectShaders.d.ts +9 -0
  468. package/dist/web/sharedEffectShaders.js +165 -0
  469. package/dist/web/sharedFrameUpload.d.ts +25 -0
  470. package/dist/web/sharedFrameUpload.js +2 -0
  471. package/dist/web/sharedHostDeferred.d.ts +7 -0
  472. package/dist/web/sharedHostDeferred.js +12 -0
  473. package/dist/web/sharedRetentionLedger.d.ts +85 -0
  474. package/dist/web/sharedRetentionLedger.js +391 -0
  475. package/dist/web/sharedSubmissionStorage2D.d.ts +56 -0
  476. package/dist/web/sharedSubmissionStorage2D.js +73 -0
  477. package/dist/web/sharedWebGL2Arena.d.ts +40 -0
  478. package/dist/web/sharedWebGL2Arena.js +77 -0
  479. package/dist/web/sharedWebGL2Options.d.ts +30 -0
  480. package/dist/web/sharedWebGL2Options.js +96 -0
  481. package/dist/web/sharedWebGL2Shaders.d.ts +20 -0
  482. package/dist/web/sharedWebGL2Shaders.js +314 -0
  483. package/dist/web/sharedWebGPUOptions.d.ts +37 -0
  484. package/dist/web/sharedWebGPUOptions.js +126 -0
  485. package/dist/web/text.d.ts +3 -0
  486. package/dist/web/text.js +3 -0
  487. package/dist/web/textInput.d.ts +3 -0
  488. package/dist/web/textInput.js +3 -0
  489. package/dist/web/video.d.ts +3 -0
  490. package/dist/web/video.js +4 -0
  491. package/dist/web/webgl2.d.ts +7 -0
  492. package/dist/web/webgl2.js +4 -0
  493. package/dist/web/webgl2LayerState.d.ts +50 -0
  494. package/dist/web/webgl2LayerState.js +102 -0
  495. package/dist/web/webgl2Native.d.ts +70 -0
  496. package/dist/web/webgl2Native.js +568 -0
  497. package/dist/web/webgl2Types.d.ts +132 -0
  498. package/dist/web/webgl2Types.js +2 -0
  499. package/dist/web/webgpu.d.ts +6 -0
  500. package/dist/web/webgpu.js +2 -0
  501. package/dist/web/webgpuBindingCache.d.ts +26 -0
  502. package/dist/web/webgpuBindingCache.js +223 -0
  503. package/dist/web/webgpuBufferPool.d.ts +51 -0
  504. package/dist/web/webgpuBufferPool.js +58 -0
  505. package/dist/web/webgpuImageResidency.d.ts +53 -0
  506. package/dist/web/webgpuImageResidency.js +61 -0
  507. package/dist/web/webgpuLifetime.d.ts +45 -0
  508. package/dist/web/webgpuLifetime.js +64 -0
  509. package/dist/web/webgpuRetentionPool.d.ts +66 -0
  510. package/dist/web/webgpuRetentionPool.js +84 -0
  511. package/dist/web/webgpuSharedPass.d.ts +7 -0
  512. package/dist/web/webgpuSharedPass.js +211 -0
  513. package/dist/web/webgpuSharedResolvePass.d.ts +3 -0
  514. package/dist/web/webgpuSharedResolvePass.js +29 -0
  515. package/dist/web/world3d/Audio3D.d.ts +68 -0
  516. package/dist/web/world3d/Audio3D.js +212 -0
  517. package/dist/web/world3d/BrowserPlay3D.d.ts +182 -0
  518. package/dist/web/world3d/BrowserPlay3D.js +851 -0
  519. package/dist/web/world3d/FlyControls3D.d.ts +55 -0
  520. package/dist/web/world3d/FlyControls3D.js +160 -0
  521. package/dist/web/world3d/FollowControls3D.d.ts +28 -0
  522. package/dist/web/world3d/FollowControls3D.js +117 -0
  523. package/dist/web/world3d/OrbitControls3D.d.ts +55 -0
  524. package/dist/web/world3d/OrbitControls3D.js +187 -0
  525. package/dist/web/world3d/TransformControls3D.d.ts +34 -0
  526. package/dist/web/world3d/TransformControls3D.js +125 -0
  527. package/dist/web/world3d/WebGL2Renderer3D.d.ts +133 -0
  528. package/dist/web/world3d/WebGL2Renderer3D.js +1173 -0
  529. package/dist/web/world3d/WebGPURenderer3D.d.ts +110 -0
  530. package/dist/web/world3d/WebGPURenderer3D.js +1915 -0
  531. package/dist/web/world3d/World3DView.d.ts +51 -0
  532. package/dist/web/world3d/World3DView.js +77 -0
  533. package/dist/web/world3d/app3D.d.ts +136 -0
  534. package/dist/web/world3d/app3D.js +304 -0
  535. package/dist/web/world3d/assets3D.d.ts +38 -0
  536. package/dist/web/world3d/assets3D.js +112 -0
  537. package/dist/web/world3d/atmosphere3D.d.ts +47 -0
  538. package/dist/web/world3d/atmosphere3D.js +178 -0
  539. package/dist/web/world3d/frame3D.d.ts +142 -0
  540. package/dist/web/world3d/frame3D.js +388 -0
  541. package/dist/web/world3d/gpuResources3D.d.ts +98 -0
  542. package/dist/web/world3d/gpuResources3D.js +901 -0
  543. package/dist/web/world3d/host3D.d.ts +23 -0
  544. package/dist/web/world3d/host3D.js +61 -0
  545. package/dist/web/world3d/index.d.ts +38 -0
  546. package/dist/web/world3d/index.js +23 -0
  547. package/dist/web/world3d/loaders3D.d.ts +26 -0
  548. package/dist/web/world3d/loaders3D.js +138 -0
  549. package/dist/web/world3d/markers3D.d.ts +49 -0
  550. package/dist/web/world3d/markers3D.js +130 -0
  551. package/dist/web/world3d/materialWebGL23D.d.ts +34 -0
  552. package/dist/web/world3d/materialWebGL23D.js +218 -0
  553. package/dist/web/world3d/overlay3D.d.ts +28 -0
  554. package/dist/web/world3d/overlay3D.js +170 -0
  555. package/dist/web/world3d/post3D.d.ts +112 -0
  556. package/dist/web/world3d/post3D.js +459 -0
  557. package/dist/web/world3d/postWebGL23D.d.ts +24 -0
  558. package/dist/web/world3d/postWebGL23D.js +237 -0
  559. package/dist/web/world3d/postWebGPU3D.d.ts +23 -0
  560. package/dist/web/world3d/postWebGPU3D.js +255 -0
  561. package/dist/web/world3d/probe3D.d.ts +14 -0
  562. package/dist/web/world3d/probe3D.js +66 -0
  563. package/dist/web/world3d/shaders3D.d.ts +43 -0
  564. package/dist/web/world3d/shaders3D.js +851 -0
  565. package/dist/web/world3d/stats3D.d.ts +31 -0
  566. package/dist/web/world3d/stats3D.js +80 -0
  567. package/dist/web/world3d/webGL2FrameMetrics3D.d.ts +66 -0
  568. package/dist/web/world3d/webGL2FrameMetrics3D.js +185 -0
  569. package/dist/web/world3d/webgpu.d.ts +35 -0
  570. package/dist/web/world3d/webgpu.js +22 -0
  571. package/dist/web/world3d/webgpuPacking3D.d.ts +13 -0
  572. package/dist/web/world3d/webgpuPacking3D.js +85 -0
  573. package/dist/web/world3d/wgsl3D.d.ts +68 -0
  574. package/dist/web/world3d/wgsl3D.js +781 -0
  575. package/package.json +220 -4
@@ -0,0 +1,281 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ import { EgretError } from '@egret/runtime';
3
+ /** The standard layout: the place of each named button, and the two axes of each stick. */
4
+ const NAMES = [
5
+ 'a',
6
+ 'b',
7
+ 'x',
8
+ 'y',
9
+ 'l1',
10
+ 'r1',
11
+ 'l2',
12
+ 'r2',
13
+ 'select',
14
+ 'start',
15
+ 'l3',
16
+ 'r3',
17
+ 'up',
18
+ 'down',
19
+ 'left',
20
+ 'right',
21
+ 'home'
22
+ ];
23
+ const STICKS = { left: 0, right: 2 };
24
+ const NONE = Object.freeze({ x: 0, y: 0 });
25
+ const LET_GO = Object.freeze({ pressed: false, value: 0 });
26
+ const record = (value) => value !== null && typeof value === 'object';
27
+ const within = (value, least, most) => typeof value === 'number' && value >= least && value <= most;
28
+ const whole = (value, least, most) => Number.isSafeInteger(value) && within(value, least, most);
29
+ /** Pads as a stream of samples a host gives it: what is held, how far a stick is pushed, and what changed since the last look. */
30
+ export function createGamepadInput(options = {}) {
31
+ if (options === null || typeof options !== 'object' || Array.isArray(options))
32
+ throw new EgretError('GAMEPAD_OPTIONS_INVALID');
33
+ const { deadZone = 0.15, maxPads = 4, onButton, onConnection } = options;
34
+ if (!within(deadZone, 0, 0.9) ||
35
+ !whole(maxPads, 1, 8) ||
36
+ (onButton !== undefined && typeof onButton !== 'function') ||
37
+ (onConnection !== undefined && typeof onConnection !== 'function'))
38
+ throw new EgretError('GAMEPAD_OPTIONS_INVALID');
39
+ const pads = new Map();
40
+ const buttonListeners = new Set();
41
+ const sampleListeners = new Set();
42
+ let closed = false, closing = false, busy = false, last = 0, faces = Object.freeze([]);
43
+ function place(pad, button) {
44
+ const index = typeof button === 'number' ? button : NAMES.indexOf(button);
45
+ if (!whole(index, 0, 63))
46
+ throw new EgretError('GAMEPAD_BUTTON_UNKNOWN');
47
+ // A name means a place only where the host has arranged the pad in the standard layout.
48
+ return typeof button === 'number' || pad.standard ? index : -1;
49
+ }
50
+ function makePad(sample) {
51
+ const pad = {
52
+ index: sample.index,
53
+ id: sample.id,
54
+ standard: sample.mapping === 'standard',
55
+ buttons: [],
56
+ axes: [],
57
+ face: Object.freeze({
58
+ index: sample.index,
59
+ id: sample.id,
60
+ standard: sample.mapping === 'standard',
61
+ get buttonCount() {
62
+ return pad.buttons.length;
63
+ },
64
+ get axisCount() {
65
+ return pad.axes.length;
66
+ },
67
+ pressed: (button) => pad.buttons[place(pad, button)]?.pressed ?? false,
68
+ value: (button) => pad.buttons[place(pad, button)]?.value ?? 0,
69
+ axis(index) {
70
+ if (!whole(index, 0, 15))
71
+ throw new EgretError('GAMEPAD_AXIS_UNKNOWN');
72
+ return pad.axes[index] ?? 0;
73
+ },
74
+ stick(name) {
75
+ if (!Object.hasOwn(STICKS, name))
76
+ throw new EgretError('GAMEPAD_STICK_UNKNOWN');
77
+ if (!pad.standard)
78
+ return NONE;
79
+ const x = pad.axes[STICKS[name]] ?? 0, y = pad.axes[STICKS[name] + 1] ?? 0, length = Math.hypot(x, y);
80
+ if (length <= deadZone)
81
+ return NONE;
82
+ // What is left of the travel outside the dead zone, stretched to reach 1 and held there.
83
+ const scale = Math.min(1, (length - deadZone) / (1 - deadZone)) / length;
84
+ return Object.freeze({ x: x * scale, y: y * scale });
85
+ }
86
+ })
87
+ };
88
+ return pad;
89
+ }
90
+ /** A sample is read whole before anything is told: one that is not what it should be changes nothing. */
91
+ function admit(sample) {
92
+ if (!record(sample))
93
+ throw new EgretError('GAMEPAD_SAMPLE');
94
+ const { index, id, mapping, buttons, axes } = sample;
95
+ if (!whole(index, 0, 31) ||
96
+ typeof id !== 'string' ||
97
+ typeof mapping !== 'string' ||
98
+ !Array.isArray(buttons) ||
99
+ buttons.length > 64 ||
100
+ !Array.isArray(axes) ||
101
+ axes.length > 16)
102
+ throw new EgretError('GAMEPAD_SAMPLE');
103
+ const held = [], pushed = [];
104
+ for (const button of buttons) {
105
+ if (!record(button) || typeof button['pressed'] !== 'boolean' || !within(button['value'], 0, 1))
106
+ throw new EgretError('GAMEPAD_SAMPLE');
107
+ held.push(Object.freeze({ pressed: button['pressed'], value: button['value'] }));
108
+ }
109
+ for (const axis of axes) {
110
+ if (!within(axis, -1, 1))
111
+ throw new EgretError('GAMEPAD_SAMPLE');
112
+ pushed.push(axis);
113
+ }
114
+ return { sample: { index, id, mapping, buttons: held, axes: pushed }, buttons: held, axes: pushed };
115
+ }
116
+ /** Every listener is told, whatever an earlier one did. What they threw is kept for the end of the look. */
117
+ function tell(listeners, value, failures) {
118
+ for (const listener of [...listeners]) {
119
+ if (listener === undefined)
120
+ continue;
121
+ try {
122
+ listener(value);
123
+ }
124
+ catch (cause) {
125
+ failures.push(cause);
126
+ }
127
+ }
128
+ }
129
+ function change(pad, index, button, timestamp, failures) {
130
+ const told = Object.freeze({
131
+ pad: pad.index,
132
+ index,
133
+ name: pad.standard ? NAMES[index] : undefined,
134
+ pressed: button.pressed,
135
+ value: button.value,
136
+ timestamp
137
+ });
138
+ tell([onButton, ...buttonListeners], told, failures);
139
+ }
140
+ function letGo(pad, timestamp, failures) {
141
+ const before = pad.buttons;
142
+ pad.buttons = before.map(() => LET_GO);
143
+ pad.axes = pad.axes.map(() => 0);
144
+ before.forEach((button, index) => {
145
+ if (button.pressed)
146
+ change(pad, index, LET_GO, timestamp, failures);
147
+ });
148
+ }
149
+ function connection(pad, connected, timestamp, failures) {
150
+ tell([onConnection], Object.freeze({ pad: pad.index, id: pad.id, connected, standard: pad.standard, timestamp }), failures);
151
+ }
152
+ /** By index, whatever order the pads came in: what is told is told in the same order every time. */
153
+ const ordered = () => [...pads.values()].sort((a, b) => a.index - b.index);
154
+ function refresh() {
155
+ faces = Object.freeze(ordered().map(pad => pad.face));
156
+ }
157
+ function close(failures) {
158
+ for (const pad of ordered())
159
+ letGo(pad, last, failures);
160
+ closed = true;
161
+ pads.clear();
162
+ refresh();
163
+ buttonListeners.clear();
164
+ sampleListeners.clear();
165
+ }
166
+ /** One look at a time: a listener may read the pads but not give the next look. */
167
+ function exclusive(action) {
168
+ if (busy)
169
+ throw new EgretError('GAMEPAD_REENTRANT');
170
+ busy = true;
171
+ const failures = [];
172
+ try {
173
+ action(failures);
174
+ // Asked for by a listener while it was being told: done once the telling is over.
175
+ if (closing && !closed)
176
+ close(failures);
177
+ }
178
+ finally {
179
+ busy = false;
180
+ }
181
+ if (failures.length > 0)
182
+ throw new EgretError('GAMEPAD_LISTENER_FAILED', { cause: failures[0], cleanupErrors: failures.slice(1) });
183
+ }
184
+ return Object.freeze({
185
+ get state() {
186
+ return closed ? 'closed' : 'active';
187
+ },
188
+ get pads() {
189
+ return faces;
190
+ },
191
+ pad: (index) => pads.get(index)?.face,
192
+ sample(samples, timestamp) {
193
+ if (!Array.isArray(samples) || samples.length > 32 || !within(timestamp, last, Number.MAX_VALUE))
194
+ throw new EgretError('GAMEPAD_SAMPLE');
195
+ if (closed)
196
+ return;
197
+ const admitted = new Map();
198
+ for (const sample of samples) {
199
+ if (sample === null || sample === undefined)
200
+ continue;
201
+ const entry = admit(sample);
202
+ if (admitted.has(entry.sample.index))
203
+ throw new EgretError('GAMEPAD_SAMPLE');
204
+ admitted.set(entry.sample.index, entry);
205
+ }
206
+ exclusive(failures => {
207
+ last = timestamp;
208
+ // Taken away, or another pad in its place: what it held is let go before it is forgotten.
209
+ for (const pad of ordered()) {
210
+ const now = admitted.get(pad.index);
211
+ if (now !== undefined && now.sample.id === pad.id && (now.sample.mapping === 'standard') === pad.standard)
212
+ continue;
213
+ letGo(pad, timestamp, failures);
214
+ pads.delete(pad.index);
215
+ refresh();
216
+ connection(pad, false, timestamp, failures);
217
+ }
218
+ for (const index of [...admitted.keys()].sort((a, b) => a - b)) {
219
+ const { sample, buttons, axes } = admitted.get(index);
220
+ let pad = pads.get(index);
221
+ if (pad === undefined) {
222
+ if (pads.size >= maxPads)
223
+ continue;
224
+ pad = makePad(sample);
225
+ pads.set(index, pad);
226
+ refresh();
227
+ connection(pad, true, timestamp, failures);
228
+ }
229
+ const before = pad.buttons;
230
+ pad.buttons = buttons;
231
+ pad.axes = axes;
232
+ const count = Math.max(before.length, buttons.length);
233
+ for (let button = 0; button < count; button++) {
234
+ const was = before[button]?.pressed ?? false, is = buttons[button] ?? LET_GO;
235
+ if (was !== is.pressed)
236
+ change(pad, button, is, timestamp, failures);
237
+ }
238
+ }
239
+ tell(sampleListeners, timestamp, failures);
240
+ });
241
+ },
242
+ release() {
243
+ if (closed)
244
+ return;
245
+ exclusive(failures => {
246
+ for (const pad of ordered())
247
+ letGo(pad, last, failures);
248
+ });
249
+ },
250
+ subscribe(listener) {
251
+ if (typeof listener !== 'function')
252
+ throw new EgretError('GAMEPAD_OPTIONS_INVALID');
253
+ if (closed)
254
+ throw new EgretError('GAMEPAD_CLOSED');
255
+ buttonListeners.add(listener);
256
+ return () => {
257
+ buttonListeners.delete(listener);
258
+ };
259
+ },
260
+ onSample(listener) {
261
+ if (typeof listener !== 'function')
262
+ throw new EgretError('GAMEPAD_OPTIONS_INVALID');
263
+ if (closed)
264
+ throw new EgretError('GAMEPAD_CLOSED');
265
+ sampleListeners.add(listener);
266
+ return () => {
267
+ sampleListeners.delete(listener);
268
+ };
269
+ },
270
+ dispose() {
271
+ if (closed)
272
+ return;
273
+ if (busy) {
274
+ closing = true;
275
+ return;
276
+ }
277
+ exclusive(close);
278
+ }
279
+ });
280
+ }
281
+ //# sourceMappingURL=gamepadInput.js.map
@@ -0,0 +1,4 @@
1
+ import type { GamepadKeys, GamepadKeysOptions } from './gamepadTypes.js';
2
+ /** Drives a keyboard input from the pads: the keys a UI already answers, held and repeated as a pad holds them. */
3
+ export declare function bindGamepadKeys(options: GamepadKeysOptions): GamepadKeys;
4
+ //# sourceMappingURL=gamepadKeys.d.ts.map
@@ -0,0 +1,205 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ import { EgretError } from '@egret/runtime';
3
+ const DIRECTIONS = ['up', 'down', 'left', 'right'];
4
+ const NAMES = [
5
+ 'a',
6
+ 'b',
7
+ 'x',
8
+ 'y',
9
+ 'l1',
10
+ 'r1',
11
+ 'l2',
12
+ 'r2',
13
+ 'select',
14
+ 'start',
15
+ 'l3',
16
+ 'r3',
17
+ 'up',
18
+ 'down',
19
+ 'left',
20
+ 'right',
21
+ 'home'
22
+ ];
23
+ /**
24
+ * What a pad does to a UI unless told otherwise. A direction is an arrow key, and an arrow nobody
25
+ * took moves the focus, so one cross walks both inside a control and from control to control.
26
+ */
27
+ const USUAL = Object.freeze({
28
+ up: { key: 'ArrowUp', otherwise: 'previous' },
29
+ down: { key: 'ArrowDown', otherwise: 'next' },
30
+ left: { key: 'ArrowLeft', otherwise: 'previous' },
31
+ right: { key: 'ArrowRight', otherwise: 'next' },
32
+ a: { key: 'Enter' },
33
+ b: { key: 'Escape' },
34
+ l1: { focus: 'previous' },
35
+ r1: { focus: 'next' }
36
+ });
37
+ const record = (value) => value !== null && typeof value === 'object' && !Array.isArray(value);
38
+ const within = (value, least, most) => typeof value === 'number' && value >= least && value <= most;
39
+ const way = (value) => value === 'next' || value === 'previous';
40
+ const text = (value) => typeof value === 'string' && value.length > 0 && value.length <= 32;
41
+ /** Drives a keyboard input from the pads: the keys a UI already answers, held and repeated as a pad holds them. */
42
+ export function bindGamepadKeys(options) {
43
+ if (!record(options))
44
+ throw new EgretError('GAMEPAD_OPTIONS_INVALID');
45
+ const { gamepad, keyboard, pad: only, map: given = {}, stick = 'left', wrap = true, threshold = 0.5, repeatDelay = 400, repeatInterval = 100 } = options;
46
+ if (!record(gamepad) ||
47
+ typeof gamepad.subscribe !== 'function' ||
48
+ typeof gamepad.onSample !== 'function' ||
49
+ !record(keyboard) ||
50
+ typeof keyboard.keyDown !== 'function' ||
51
+ typeof keyboard.keyUp !== 'function' ||
52
+ typeof keyboard.moveFocus !== 'function' ||
53
+ (only !== undefined && !(Number.isSafeInteger(only) && within(only, 0, 31))) ||
54
+ !record(given) ||
55
+ (stick !== false && stick !== 'left' && stick !== 'right') ||
56
+ typeof wrap !== 'boolean' ||
57
+ !within(threshold, 0.1, 1) ||
58
+ !within(repeatDelay, 50, 5000) ||
59
+ !within(repeatInterval, 20, 5000))
60
+ throw new EgretError('GAMEPAD_OPTIONS_INVALID');
61
+ const map = new Map();
62
+ for (const name of NAMES) {
63
+ const action = Object.hasOwn(given, name) ? given[name] : USUAL[name];
64
+ if (action === null || action === undefined)
65
+ continue;
66
+ if (!record(action) ||
67
+ !('focus' in action
68
+ ? way(action.focus)
69
+ : text(action['key']) &&
70
+ (action['code'] === undefined || text(action['code'])) &&
71
+ (action['otherwise'] === undefined || way(action['otherwise']))))
72
+ throw new EgretError('GAMEPAD_OPTIONS_INVALID');
73
+ map.set(name, action);
74
+ }
75
+ for (const name of Object.keys(given))
76
+ if (!NAMES.includes(name))
77
+ throw new EgretError('GAMEPAD_BUTTON_UNKNOWN');
78
+ /** What is held, by pad and button. A key held by two buttons is one key: it goes down once and up once. */
79
+ const holds = new Map();
80
+ const keys = new Map();
81
+ /** The direction each stick is taken to point at, kept until it clearly lets go. */
82
+ const pointed = new Map();
83
+ let disposed = false, time = 0;
84
+ function fire(hold, repeat) {
85
+ const action = hold.action;
86
+ if ('focus' in action) {
87
+ keyboard.moveFocus(action.focus, wrap);
88
+ return;
89
+ }
90
+ const taken = keyboard.keyDown({ code: action.code ?? action.key, key: action.key, repeat });
91
+ if (!taken && action.otherwise !== undefined)
92
+ keyboard.moveFocus(action.otherwise, wrap);
93
+ }
94
+ function press(id, name, timestamp) {
95
+ const action = map.get(name);
96
+ if (action === undefined)
97
+ return;
98
+ const hold = {
99
+ action,
100
+ repeats: 'focus' in action || DIRECTIONS.includes(name),
101
+ next: timestamp + repeatDelay
102
+ };
103
+ holds.set(id, hold);
104
+ if ('key' in action) {
105
+ const count = keys.get(action.key) ?? 0;
106
+ keys.set(action.key, count + 1);
107
+ if (count > 0)
108
+ return;
109
+ }
110
+ fire(hold, false);
111
+ }
112
+ function release(id, hold) {
113
+ holds.delete(id);
114
+ const action = hold.action;
115
+ if (!('key' in action))
116
+ return;
117
+ const count = (keys.get(action.key) ?? 1) - 1;
118
+ if (count > 0) {
119
+ keys.set(action.key, count);
120
+ return;
121
+ }
122
+ keys.delete(action.key);
123
+ keyboard.keyUp({ code: action.code ?? action.key, key: action.key });
124
+ }
125
+ /** Where a stick points: the side it leans to most, once it passes the threshold, until it falls well below it. */
126
+ function lean(pad, name) {
127
+ const { x, y } = pad.stick(name), before = pointed.get(pad.index);
128
+ const along = (direction) => direction === 'up' ? -y : direction === 'down' ? y : direction === 'left' ? -x : x;
129
+ if (before !== undefined && along(before) >= threshold * 0.7)
130
+ return before;
131
+ const now = Math.abs(x) >= Math.abs(y) ? (x < 0 ? 'left' : 'right') : y < 0 ? 'up' : 'down';
132
+ const direction = along(now) >= threshold ? now : undefined;
133
+ if (direction === undefined)
134
+ pointed.delete(pad.index);
135
+ else
136
+ pointed.set(pad.index, direction);
137
+ return direction;
138
+ }
139
+ /** Brings what is held into line with what the pads say now, then repeats what has been held long enough. */
140
+ function sync(timestamp, repeat) {
141
+ if (disposed)
142
+ return;
143
+ time = Math.max(time, timestamp);
144
+ const wanted = new Map();
145
+ for (const pad of gamepad.pads) {
146
+ if (only !== undefined && pad.index !== only)
147
+ continue;
148
+ const direction = stick === false ? undefined : lean(pad, stick);
149
+ for (const name of map.keys())
150
+ if (pad.pressed(name) || name === direction)
151
+ wanted.set(pad.index + ':' + name, name);
152
+ }
153
+ // What was let go goes up before what was pressed goes down, as fingers do it.
154
+ for (const [id, hold] of [...holds])
155
+ if (!wanted.has(id))
156
+ release(id, hold);
157
+ for (const [id, name] of wanted)
158
+ if (!holds.has(id))
159
+ press(id, name, time);
160
+ for (const index of [...pointed.keys()])
161
+ if (gamepad.pad(index) === undefined)
162
+ pointed.delete(index);
163
+ if (!repeat)
164
+ return;
165
+ for (const hold of [...holds.values()]) {
166
+ if (!hold.repeats || time < hold.next)
167
+ continue;
168
+ // One repeat for one look, however late the look is.
169
+ hold.next = time + repeatInterval;
170
+ fire(hold, true);
171
+ }
172
+ }
173
+ const off = [
174
+ gamepad.subscribe(change => {
175
+ sync(change.timestamp, false);
176
+ }),
177
+ gamepad.onSample(timestamp => {
178
+ sync(timestamp, true);
179
+ })
180
+ ];
181
+ return Object.freeze({
182
+ get held() {
183
+ return Object.freeze([...keys.keys()]);
184
+ },
185
+ dispose() {
186
+ if (disposed)
187
+ return;
188
+ disposed = true;
189
+ for (const stop of off)
190
+ stop();
191
+ const failures = [];
192
+ for (const [id, hold] of [...holds])
193
+ try {
194
+ release(id, hold);
195
+ }
196
+ catch (cause) {
197
+ failures.push(cause);
198
+ }
199
+ pointed.clear();
200
+ if (failures.length > 0)
201
+ throw new EgretError('GAMEPAD_LISTENER_FAILED', { cause: failures[0], cleanupErrors: failures.slice(1) });
202
+ }
203
+ });
204
+ }
205
+ //# sourceMappingURL=gamepadKeys.js.map
@@ -0,0 +1,134 @@
1
+ /** The buttons of a pad in the standard layout, by where they are: `a` is the lower face button. */
2
+ export type GamepadButtonName = 'a' | 'b' | 'x' | 'y' | 'l1' | 'r1' | 'l2' | 'r2' | 'select' | 'start' | 'l3' | 'r3' | 'up' | 'down' | 'left' | 'right' | 'home';
3
+ export type GamepadStickName = 'left' | 'right';
4
+ export interface GamepadButtonSample {
5
+ readonly pressed: boolean;
6
+ /** 0 to 1: how far a trigger is pulled. A plain button says 0 or 1. */
7
+ readonly value: number;
8
+ }
9
+ /** What a host says of one pad at one moment. */
10
+ export interface GamepadSample {
11
+ readonly index: number;
12
+ readonly id: string;
13
+ /** 'standard' when the host has arranged the buttons and axes in the standard layout. */
14
+ readonly mapping: string;
15
+ readonly buttons: readonly GamepadButtonSample[];
16
+ /** -1 to 1 each. In the standard layout: left stick x and y, right stick x and y; down and right are positive. */
17
+ readonly axes: readonly number[];
18
+ }
19
+ export interface GamepadStick {
20
+ readonly x: number;
21
+ readonly y: number;
22
+ }
23
+ /** A pad that is connected, as of the last sample. */
24
+ export interface GamepadPad {
25
+ readonly index: number;
26
+ readonly id: string;
27
+ /** Whether the names of buttons and sticks mean anything for this pad. */
28
+ readonly standard: boolean;
29
+ readonly buttonCount: number;
30
+ readonly axisCount: number;
31
+ /** By name in the standard layout, or by number for any pad. A button the pad does not have is not pressed. */
32
+ pressed(button: GamepadButtonName | number): boolean;
33
+ value(button: GamepadButtonName | number): number;
34
+ /** One axis as the host gave it. */
35
+ axis(index: number): number;
36
+ /** A stick with the dead zone taken out: nothing inside it, and the rest stretched to reach 1. */
37
+ stick(name: GamepadStickName): GamepadStick;
38
+ }
39
+ export interface GamepadButtonChange {
40
+ readonly pad: number;
41
+ /** The number of the button on its pad. */
42
+ readonly index: number;
43
+ /** Its name, when the pad is in the standard layout and the button has one. */
44
+ readonly name: GamepadButtonName | undefined;
45
+ readonly pressed: boolean;
46
+ readonly value: number;
47
+ readonly timestamp: number;
48
+ }
49
+ export interface GamepadConnectionChange {
50
+ readonly pad: number;
51
+ readonly id: string;
52
+ readonly connected: boolean;
53
+ readonly standard: boolean;
54
+ readonly timestamp: number;
55
+ }
56
+ export interface GamepadInputOptions {
57
+ /** The part of a stick around its middle that counts as the middle, 0 to 0.9. Defaults to 0.15. */
58
+ readonly deadZone?: number;
59
+ /** Pads followed at once, 1 to 8. Others are left out. Defaults to 4. */
60
+ readonly maxPads?: number;
61
+ readonly onButton?: (change: GamepadButtonChange) => void;
62
+ readonly onConnection?: (change: GamepadConnectionChange) => void;
63
+ }
64
+ /**
65
+ * Pads as a stream of samples. It reads no device: a host gives it what every connected pad says,
66
+ * each time it looks, and it tells what changed between one look and the next.
67
+ */
68
+ export interface GamepadInput {
69
+ readonly state: 'active' | 'closed';
70
+ /** The pads that are connected, by index. */
71
+ readonly pads: readonly GamepadPad[];
72
+ pad(index: number): GamepadPad | undefined;
73
+ /**
74
+ * Everything that is connected now. A pad that is not among the samples has been taken away:
75
+ * its buttons are let go first. The timestamp is in milliseconds and does not go back.
76
+ */
77
+ sample(samples: readonly (GamepadSample | null | undefined)[], timestamp: number): void;
78
+ /** Lets every button go, as when the page loses the person's attention. The pads stay. */
79
+ release(): void;
80
+ /** Told each press and each letting go, after `onButton`. */
81
+ subscribe(listener: (change: GamepadButtonChange) => void): () => void;
82
+ /** Told after each sample has been taken in, with its timestamp. */
83
+ onSample(listener: (timestamp: number) => void): () => void;
84
+ /** Lets every button go and forgets the pads. A scope can own the input through this. */
85
+ dispose(): void;
86
+ }
87
+ /** The part of a keyboard input that a pad drives. The logical keyboard input of the Engine is one. */
88
+ export interface GamepadKeyTarget {
89
+ keyDown(sample: {
90
+ readonly code: string;
91
+ readonly key: string;
92
+ readonly repeat?: boolean;
93
+ }): boolean;
94
+ keyUp(sample: {
95
+ readonly code: string;
96
+ readonly key: string;
97
+ }): boolean;
98
+ moveFocus(direction: 'next' | 'previous', wrap?: boolean): string | undefined;
99
+ }
100
+ /**
101
+ * What a button does: a key, with the way the focus moves when nobody took the key; or a move of
102
+ * the focus alone.
103
+ */
104
+ export type GamepadKeyAction = {
105
+ readonly key: string;
106
+ readonly code?: string;
107
+ readonly otherwise?: 'next' | 'previous';
108
+ } | {
109
+ readonly focus: 'next' | 'previous';
110
+ };
111
+ export interface GamepadKeysOptions {
112
+ readonly gamepad: GamepadInput;
113
+ readonly keyboard: GamepadKeyTarget;
114
+ /** Only this pad. Without it every pad drives the keys. */
115
+ readonly pad?: number;
116
+ /** Replaces the usual action of a button, or takes it away with `null`. */
117
+ readonly map?: Partial<Record<GamepadButtonName, GamepadKeyAction | null>>;
118
+ /** The stick that also counts as the four directions. Defaults to 'left'; `false` for none. */
119
+ readonly stick?: GamepadStickName | false;
120
+ /** Whether the focus goes round from the last stop to the first. A pad has nowhere else to go: defaults to true. */
121
+ readonly wrap?: boolean;
122
+ /** How far the stick has to be pushed to count, 0.1 to 1. Defaults to 0.5. */
123
+ readonly threshold?: number;
124
+ /** Milliseconds a direction is held before it repeats, and between repeats. Default to 400 and 100. */
125
+ readonly repeatDelay?: number;
126
+ readonly repeatInterval?: number;
127
+ }
128
+ export interface GamepadKeys {
129
+ /** The keys held down now. */
130
+ readonly held: readonly string[];
131
+ /** Lets the held keys go and stops listening to the pads. */
132
+ dispose(): void;
133
+ }
134
+ //# sourceMappingURL=gamepadTypes.d.ts.map
@@ -0,0 +1,3 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ export {};
3
+ //# sourceMappingURL=gamepadTypes.js.map
@@ -0,0 +1,4 @@
1
+ /** Optional hover and wheel routing: no browser listener or renderer is loaded by this entry. */
2
+ export { createHoverInput } from './hoverInput.js';
3
+ export type { HoverInput, HoverInputEvents, HoverInputOptions, HoverInputState, HoverLeaveReason, HoverNotification, HoverPoint, HoverPointerType, HoverSample, HoverState, HoverTransition, WheelNotification, WheelPoint, WheelSample, WheelUnit } from './hoverInputTypes.js';
4
+ //# sourceMappingURL=hover.d.ts.map
package/dist/hover.js ADDED
@@ -0,0 +1,4 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ /** Optional hover and wheel routing: no browser listener or renderer is loaded by this entry. */
3
+ export { createHoverInput } from './hoverInput.js';
4
+ //# sourceMappingURL=hover.js.map
@@ -0,0 +1,8 @@
1
+ import type { HoverInput, HoverInputOptions } from './hoverInputTypes.js';
2
+ export type { HoverInput, HoverInputEvents, HoverInputOptions, HoverInputState, HoverLeaveReason, HoverNotification, HoverPoint, HoverPointerType, HoverSample, HoverState, HoverTransition, WheelNotification, WheelPoint, WheelSample, WheelUnit } from './hoverInputTypes.js';
3
+ /**
4
+ * Hover and wheel routing over the display tree of a started Engine. It holds no contact: a press
5
+ * belongs to the pointer input, and a pointer that presses stops hovering until it is released.
6
+ */
7
+ export declare function createHoverInput(options: HoverInputOptions): HoverInput;
8
+ //# sourceMappingURL=hoverInput.d.ts.map