@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,75 @@
1
+ import type { ColorInput3D } from './Material3D.js';
2
+ import { Object3D } from './Object3D.js';
3
+ export type LightType3D = 'ambient' | 'hemisphere' | 'directional' | 'point' | 'spot';
4
+ export declare const LIGHT3D_LIMITS: Readonly<{
5
+ readonly maxDirectional: 4;
6
+ readonly maxPoint: 8;
7
+ /** Point lights with a range lit through the tiled list, beyond the eight lit directly. */
8
+ readonly maxTiledPoint: 256;
9
+ readonly maxSpot: 4;
10
+ readonly maxShadows: 4;
11
+ }>;
12
+ export interface LightShadow3D {
13
+ /** Edge of this light's square tile in the shared shadow atlas, in texels. */
14
+ mapSize: number;
15
+ /** Constant depth offset against shadow acne. */
16
+ bias: number;
17
+ /** Offset along the surface normal, in world units. */
18
+ normalBias: number;
19
+ near: number;
20
+ far: number;
21
+ /** Half extent of the orthographic volume used by directional lights. */
22
+ extent: number;
23
+ /** Percentage-closer filter radius in texels; 0 samples once. */
24
+ radius: number;
25
+ /**
26
+ * Number of cascades for a directional light, 1 to 4. Each cascade takes
27
+ * one atlas tile and follows the camera, so `extent` is ignored above 1.
28
+ * Only the first cascaded directional light in a scene is split.
29
+ */
30
+ cascades: number;
31
+ /** Distance from the camera, in world units, that cascaded shadows cover. */
32
+ cascadeDistance: number;
33
+ /** Split distribution: 0 spaces cascades evenly, 1 logarithmically. */
34
+ cascadeLambda: number;
35
+ }
36
+ export interface LightOptions3D {
37
+ readonly color?: ColorInput3D;
38
+ readonly intensity?: number;
39
+ readonly castShadow?: boolean;
40
+ }
41
+ export interface PointLightOptions3D extends LightOptions3D {
42
+ /** Distance at which the light fades to zero; 0 means unbounded inverse-square falloff. */
43
+ readonly range?: number;
44
+ }
45
+ export interface SpotLightOptions3D extends PointLightOptions3D {
46
+ /** Half angle of the cone in radians. */
47
+ readonly angle?: number;
48
+ /** Fraction of the cone over which intensity falls off, in [0, 1]. */
49
+ readonly penumbra?: number;
50
+ }
51
+ export declare class Light3D extends Object3D {
52
+ readonly lightType: LightType3D;
53
+ readonly color: Float32Array<ArrayBuffer>;
54
+ intensity: number;
55
+ /** Lower hemisphere color for hemisphere lights. */
56
+ readonly groundColor: Float32Array<ArrayBuffer>;
57
+ range: number;
58
+ angle: number;
59
+ penumbra: number;
60
+ readonly shadow: LightShadow3D;
61
+ constructor(lightType?: LightType3D);
62
+ clone(recursive?: boolean): this;
63
+ protected copyFrom(source: this): void;
64
+ }
65
+ /** Uniform light from every direction. */
66
+ export declare function createAmbientLight3D(options?: LightOptions3D): Light3D;
67
+ /** Sky color from above blending to a ground color from below (world Y axis). */
68
+ export declare function createHemisphereLight3D(options?: LightOptions3D & {
69
+ readonly groundColor?: ColorInput3D;
70
+ }): Light3D;
71
+ /** Parallel rays, such as sunlight. Aim it with lookAt(). */
72
+ export declare function createDirectionalLight3D(options?: LightOptions3D): Light3D;
73
+ export declare function createPointLight3D(options?: PointLightOptions3D): Light3D;
74
+ export declare function createSpotLight3D(options?: SpotLightOptions3D): Light3D;
75
+ //# sourceMappingURL=Light3D.d.ts.map
@@ -0,0 +1,93 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ // Light nodes. Directional and spot lights shine along their local negative
3
+ // Z axis, matching cameras and glTF punctual lights. Colors are linear RGB.
4
+ import { setColor3D } from './Material3D.js';
5
+ import { Object3D } from './Object3D.js';
6
+ export const LIGHT3D_LIMITS = Object.freeze({
7
+ maxDirectional: 4,
8
+ maxPoint: 8,
9
+ /** Point lights with a range lit through the tiled list, beyond the eight lit directly. */
10
+ maxTiledPoint: 256,
11
+ maxSpot: 4,
12
+ maxShadows: 4
13
+ });
14
+ export class Light3D extends Object3D {
15
+ lightType;
16
+ color = new Float32Array([1, 1, 1]);
17
+ intensity = 1;
18
+ /** Lower hemisphere color for hemisphere lights. */
19
+ groundColor = new Float32Array([0, 0, 0]);
20
+ range = 0;
21
+ angle = Math.PI / 4;
22
+ penumbra = 0.1;
23
+ shadow = {
24
+ mapSize: 1024,
25
+ bias: 0.0005,
26
+ normalBias: 0.02,
27
+ near: 0.1,
28
+ far: 100,
29
+ extent: 10,
30
+ radius: 1,
31
+ cascades: 1,
32
+ cascadeDistance: 100,
33
+ cascadeLambda: 0.7
34
+ };
35
+ constructor(lightType = 'directional') {
36
+ super('light');
37
+ this.lightType = lightType;
38
+ this.castShadow = false;
39
+ }
40
+ clone(recursive = true) {
41
+ const copy = new Light3D(this.lightType);
42
+ copy.copyFrom(this);
43
+ if (recursive)
44
+ for (const child of this.children)
45
+ copy.addChild(child.clone(true));
46
+ return copy;
47
+ }
48
+ copyFrom(source) {
49
+ super.copyFrom(source);
50
+ this.color.set(source.color);
51
+ this.groundColor.set(source.groundColor);
52
+ this.intensity = source.intensity;
53
+ this.range = source.range;
54
+ this.angle = source.angle;
55
+ this.penumbra = source.penumbra;
56
+ Object.assign(this.shadow, source.shadow);
57
+ }
58
+ }
59
+ function base(light, options) {
60
+ if (options.color !== undefined)
61
+ setColor3D(light.color, options.color);
62
+ light.intensity = options.intensity ?? 1;
63
+ light.castShadow = options.castShadow ?? false;
64
+ return light;
65
+ }
66
+ /** Uniform light from every direction. */
67
+ export function createAmbientLight3D(options = {}) {
68
+ return base(new Light3D('ambient'), { ...options, castShadow: false });
69
+ }
70
+ /** Sky color from above blending to a ground color from below (world Y axis). */
71
+ export function createHemisphereLight3D(options = {}) {
72
+ const light = base(new Light3D('hemisphere'), { ...options, castShadow: false });
73
+ if (options.groundColor !== undefined)
74
+ setColor3D(light.groundColor, options.groundColor);
75
+ return light;
76
+ }
77
+ /** Parallel rays, such as sunlight. Aim it with lookAt(). */
78
+ export function createDirectionalLight3D(options = {}) {
79
+ return base(new Light3D('directional'), options);
80
+ }
81
+ export function createPointLight3D(options = {}) {
82
+ const light = base(new Light3D('point'), options);
83
+ light.range = options.range ?? 0;
84
+ return light;
85
+ }
86
+ export function createSpotLight3D(options = {}) {
87
+ const light = base(new Light3D('spot'), options);
88
+ light.range = options.range ?? 0;
89
+ light.angle = options.angle ?? Math.PI / 4;
90
+ light.penumbra = options.penumbra ?? 0.1;
91
+ return light;
92
+ }
93
+ //# sourceMappingURL=Light3D.js.map
@@ -0,0 +1,243 @@
1
+ import { Resource3D } from './core3D.js';
2
+ import type { Texture3D } from './Texture3D.js';
3
+ /**
4
+ * A fragment hook that post-processes a material's shaded color. Supply the
5
+ * function in each shading language you target:
6
+ * GLSL: vec4 customFragment(vec4 color, vec3 worldPosition, vec3 normal, vec2 uv) reading uCustom[0..3]
7
+ * WGSL: fn customFragment(color: vec4f, worldPosition: vec3f, normal: vec3f, uv: vec2f) -> vec4f reading material.custom[0..3]
8
+ * `color` is linear and not yet fogged or tone mapped; return the new color and alpha.
9
+ * A backend without source for its language draws the material unchanged.
10
+ *
11
+ * A vertex hook displaces vertices in world space, in the visible pass and in
12
+ * shadow maps alike, so swaying foliage casts swaying shadows:
13
+ * GLSL: vec3 customVertex(vec3 worldPosition, vec3 localPosition, vec3 normal, vec2 uv, vec4 color)
14
+ * WGSL: fn customVertex(worldPosition: vec3f, localPosition: vec3f, normal: vec3f, uv: vec2f, color: vec4f) -> vec3f
15
+ * Return the new world position. Use only the arguments and the custom
16
+ * parameters; per-frame camera data is not available while drawing shadows.
17
+ * `color` is the vertex color when the material enables vertexColors, else white.
18
+ *
19
+ * A normal hook replaces the shading normal of a lit material before any
20
+ * light is computed, for surfaces whose detail is a formula rather than a
21
+ * texture, such as ripples on water:
22
+ * GLSL: vec3 customNormal(vec3 normal, vec3 worldPosition, vec2 uv)
23
+ * WGSL: fn customNormal(normal: vec3f, worldPosition: vec3f, uv: vec2f) -> vec3f
24
+ * The result is normalized for you.
25
+ */
26
+ export interface CustomShader3D {
27
+ /** Identifies the source; materials with the same key share compiled programs. */
28
+ readonly key: string;
29
+ readonly glsl?: string;
30
+ readonly wgsl?: string;
31
+ readonly glslVertex?: string;
32
+ readonly wgslVertex?: string;
33
+ readonly glslNormal?: string;
34
+ readonly wgslNormal?: string;
35
+ /** Four vec4 parameters, written by the application (time, colors, thresholds). */
36
+ readonly uniforms: Float32Array;
37
+ }
38
+ export declare function createCustomShader3D(input: {
39
+ readonly key: string;
40
+ readonly glsl?: string;
41
+ readonly wgsl?: string;
42
+ readonly glslVertex?: string;
43
+ readonly wgslVertex?: string;
44
+ readonly glslNormal?: string;
45
+ readonly wgslNormal?: string;
46
+ readonly uniforms?: ArrayLike<number>;
47
+ }): CustomShader3D;
48
+ export type Shading3D = 'unlit' | 'lambert' | 'phong' | 'standard' | 'toon' | 'matcap';
49
+ export type Side3D = 'front' | 'back' | 'double';
50
+ export type AlphaMode3D = 'opaque' | 'mask' | 'blend';
51
+ export type Blending3D = 'normal' | 'additive' | 'multiply' | 'premultiplied';
52
+ /** A color as 0xRRGGBB sRGB hex or linear RGB components. */
53
+ export type ColorInput3D = number | readonly [number, number, number];
54
+ export interface MaterialOptions3D {
55
+ readonly name?: string;
56
+ readonly color?: ColorInput3D;
57
+ readonly opacity?: number;
58
+ readonly map?: Texture3D;
59
+ readonly side?: Side3D;
60
+ readonly alphaMode?: AlphaMode3D;
61
+ readonly alphaCutoff?: number;
62
+ /** Anything but 'normal' also makes 'blend' the default `alphaMode`. */
63
+ readonly blending?: Blending3D;
64
+ readonly depthTest?: boolean;
65
+ readonly depthWrite?: boolean;
66
+ readonly vertexColors?: boolean;
67
+ readonly fog?: boolean;
68
+ readonly toneMapped?: boolean;
69
+ readonly emissive?: ColorInput3D;
70
+ readonly emissiveIntensity?: number;
71
+ readonly emissiveMap?: Texture3D;
72
+ readonly normalMap?: Texture3D;
73
+ readonly normalScale?: number;
74
+ readonly occlusionMap?: Texture3D;
75
+ readonly occlusionStrength?: number;
76
+ readonly flatShading?: boolean;
77
+ readonly wireframe?: boolean;
78
+ }
79
+ export interface PhongMaterialOptions3D extends MaterialOptions3D {
80
+ readonly specular?: ColorInput3D;
81
+ readonly shininess?: number;
82
+ }
83
+ export interface StandardMaterialOptions3D extends MaterialOptions3D {
84
+ readonly metallic?: number;
85
+ readonly roughness?: number;
86
+ /** Roughness in G and metallic in B, as in glTF. */
87
+ readonly metallicRoughnessMap?: Texture3D;
88
+ readonly environmentIntensity?: number;
89
+ }
90
+ export interface SpriteMaterialOptions3D extends MaterialOptions3D {
91
+ /** Keep a constant on-screen size regardless of distance. */
92
+ readonly sizeAttenuation?: boolean;
93
+ /** Rotation about the view axis in radians. */
94
+ readonly rotation?: number;
95
+ }
96
+ export declare function setColor3D(out: Float32Array, input: ColorInput3D): Float32Array;
97
+ /**
98
+ * One material class carries the superset of surface parameters; `shading`
99
+ * selects the lighting model. Assign fields freely and call touch() when a
100
+ * change alters shader features (maps added or removed, alpha mode, side).
101
+ * Scalar and color edits take effect on the next draw without touch().
102
+ */
103
+ export declare class Material3D extends Resource3D {
104
+ readonly shading: Shading3D;
105
+ readonly color: Float32Array<ArrayBuffer>;
106
+ opacity: number;
107
+ map: Texture3D | undefined;
108
+ side: Side3D;
109
+ alphaMode: AlphaMode3D;
110
+ /** Fragments below this alpha are discarded in 'mask' mode. */
111
+ alphaCutoff: number;
112
+ /** How a blended fragment combines with what is behind it. Used only when `alphaMode` is 'blend'. */
113
+ blending: Blending3D;
114
+ depthTest: boolean;
115
+ depthWrite: boolean;
116
+ /** Multiply the base color by the geometry's `color` attribute. */
117
+ vertexColors: boolean;
118
+ fog: boolean;
119
+ toneMapped: boolean;
120
+ visible: boolean;
121
+ readonly emissive: Float32Array<ArrayBuffer>;
122
+ emissiveIntensity: number;
123
+ emissiveMap: Texture3D | undefined;
124
+ normalMap: Texture3D | undefined;
125
+ normalScale: number;
126
+ occlusionMap: Texture3D | undefined;
127
+ occlusionStrength: number;
128
+ flatShading: boolean;
129
+ wireframe: boolean;
130
+ readonly specular: Float32Array<ArrayBuffer>;
131
+ shininess: number;
132
+ /** Optional fragment hook. Call touch() after assigning a different shader. */
133
+ shader: CustomShader3D | undefined;
134
+ /**
135
+ * Baked lighting added to the indirect light of lit materials. It is sampled
136
+ * with the texture's `channel`, normally 1 for a second, non-overlapping UV set.
137
+ */
138
+ lightMap: Texture3D | undefined;
139
+ lightMapIntensity: number;
140
+ /**
141
+ * A mirror image of the scene for a flat reflective surface on a standard
142
+ * material, normally the texture of a PlanarReflection3D. It is read at
143
+ * the pixel's own place on screen, so the mesh needs no coordinates for
144
+ * it, and it takes the place of the environment map's reflection.
145
+ */
146
+ reflectionMap: Texture3D | undefined;
147
+ reflectionStrength: number;
148
+ /** How far the surface normal pushes the mirror image sideways, as a share of the screen. */
149
+ reflectionDistortion: number;
150
+ /**
151
+ * For blended materials such as particles and haze: the distance over which
152
+ * the surface fades out where it comes close to the solid geometry behind
153
+ * it, instead of ending in a hard line. 0 turns the fade off.
154
+ */
155
+ softness: number;
156
+ /**
157
+ * Ground layers blended by a weight map, for terrain: up to four tiling
158
+ * textures, each shown where its channel of `weights` (R, G, B, A) is
159
+ * strong. Weights are read with the mesh's coordinates as they are and
160
+ * layers with those coordinates times their `repeat`. The layers take
161
+ * the texture slots of map, emissiveMap, occlusionMap, metallicRoughnessMap
162
+ * and lightMap, so leave those unset. Call touch() after assigning.
163
+ */
164
+ splat: {
165
+ readonly weights: Texture3D;
166
+ readonly layers: readonly Texture3D[];
167
+ readonly repeat: readonly number[];
168
+ } | undefined;
169
+ /** Strength, 0 to 1, of a soft rim lobe for cloth and velvet on a standard material. */
170
+ sheen: number;
171
+ readonly sheenColor: Float32Array<ArrayBuffer>;
172
+ sheenRoughness: number;
173
+ /**
174
+ * How much light passes through a standard material, 0 to 1, as for glass.
175
+ * What lies behind is drawn first and then seen through the surface,
176
+ * tinted by its color and blurred by its roughness. Such a material is
177
+ * drawn with the transparent objects whatever its alphaMode; other
178
+ * see-through and transparent objects behind it do not show through.
179
+ */
180
+ transmission: number;
181
+ /** Index of refraction for transmission: 1 does not bend light, 1.5 is glass, 1.33 water. */
182
+ ior: number;
183
+ /** How far, in world units, light travels inside a transmitting object. Zero means a thin sheet that does not bend the view. */
184
+ thickness: number;
185
+ /** Color white light takes on after travelling `attenuationDistance` inside a transmitting object. */
186
+ readonly attenuationColor: Float32Array<ArrayBuffer>;
187
+ attenuationDistance: number;
188
+ /** Strength, 0 to 1, of a clear lacquer layer over a standard material (car paint, varnish). */
189
+ clearcoat: number;
190
+ clearcoatRoughness: number;
191
+ /** Number of light bands for toon shading. */
192
+ toonSteps: number;
193
+ metallic: number;
194
+ roughness: number;
195
+ metallicRoughnessMap: Texture3D | undefined;
196
+ environmentIntensity: number;
197
+ billboard: boolean;
198
+ /** Treat vertex positions as normalized device coordinates; used by full-screen layers. */
199
+ screenSpace: boolean;
200
+ sizeAttenuation: boolean;
201
+ rotation: number;
202
+ pointSize: number;
203
+ /** Polygon offset to resolve coplanar decals: [factor, units]. */
204
+ polygonOffset: readonly [number, number] | undefined;
205
+ constructor(shading: Shading3D, options?: MaterialOptions3D);
206
+ /** True when the material must be drawn in the sorted transparent pass. */
207
+ get isTransparent(): boolean;
208
+ setColor(color: ColorInput3D): this;
209
+ setEmissive(color: ColorInput3D): this;
210
+ /** Independent copy sharing texture references. */
211
+ clone(): Material3D;
212
+ }
213
+ /** Constant color, unaffected by lights. */
214
+ export declare function createUnlitMaterial3D(options?: MaterialOptions3D): Material3D;
215
+ /** Diffuse-only lighting; the cheapest lit model. */
216
+ export declare function createLambertMaterial3D(options?: MaterialOptions3D): Material3D;
217
+ /** Diffuse plus Blinn-Phong specular highlights. */
218
+ export declare function createPhongMaterial3D(options?: PhongMaterialOptions3D): Material3D;
219
+ /** Cel shading: diffuse light quantized into `steps` flat bands. */
220
+ export declare function createToonMaterial3D(options?: MaterialOptions3D & {
221
+ readonly steps?: number;
222
+ }): Material3D;
223
+ /**
224
+ * Lighting baked into a sphere image: the surface color is looked up by the
225
+ * view-space normal, so no lights are needed. The image is held in `emissiveMap`.
226
+ */
227
+ export declare function createMatcapMaterial3D(options: MaterialOptions3D & {
228
+ readonly matcap: Texture3D;
229
+ }): Material3D;
230
+ /**
231
+ * A standard material set up as glass: smooth and see-through, with
232
+ * reflections kept. Give it a `thickness` to bend the view like a solid block.
233
+ */
234
+ export declare function createGlassMaterial3D(options?: StandardMaterialOptions3D & {
235
+ readonly transmission?: number;
236
+ readonly ior?: number;
237
+ readonly thickness?: number;
238
+ }): Material3D;
239
+ /** Physically based metallic-roughness model, matching glTF 2.0 materials. */
240
+ export declare function createStandardMaterial3D(options?: StandardMaterialOptions3D): Material3D;
241
+ /** Camera-facing unlit quad material for Sprite3D. */
242
+ export declare function createSpriteMaterial3D(options?: SpriteMaterialOptions3D): Material3D;
243
+ //# sourceMappingURL=Material3D.d.ts.map
@@ -0,0 +1,267 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ // Surface descriptions consumed by the first-party shader library. All color
3
+ // values are linear RGB; factories accept 0xRRGGBB sRGB hex for convenience.
4
+ import { Resource3D, World3DError } from './core3D.js';
5
+ import { colorFromHex } from './math3D.js';
6
+ export function createCustomShader3D(input) {
7
+ if (!input || typeof input.key !== 'string' || input.key.length === 0 || /[\s|/]/.test(input.key))
8
+ throw new World3DError('WORLD3D_INPUT_INVALID', 'shader key');
9
+ if (input.glsl === undefined &&
10
+ input.wgsl === undefined &&
11
+ input.glslVertex === undefined &&
12
+ input.wgslVertex === undefined &&
13
+ input.glslNormal === undefined &&
14
+ input.wgslNormal === undefined)
15
+ throw new World3DError('WORLD3D_INPUT_INVALID', 'shader source');
16
+ const uniforms = new Float32Array(16);
17
+ if (input.uniforms)
18
+ uniforms.set(Array.from(input.uniforms).slice(0, 16));
19
+ return Object.freeze({
20
+ key: input.key,
21
+ ...(input.glsl === undefined ? {} : { glsl: input.glsl }),
22
+ ...(input.wgsl === undefined ? {} : { wgsl: input.wgsl }),
23
+ ...(input.glslVertex === undefined ? {} : { glslVertex: input.glslVertex }),
24
+ ...(input.wgslVertex === undefined ? {} : { wgslVertex: input.wgslVertex }),
25
+ ...(input.glslNormal === undefined ? {} : { glslNormal: input.glslNormal }),
26
+ ...(input.wgslNormal === undefined ? {} : { wgslNormal: input.wgslNormal }),
27
+ uniforms
28
+ });
29
+ }
30
+ export function setColor3D(out, input) {
31
+ if (typeof input === 'number')
32
+ colorFromHex(out, input);
33
+ else if (Array.isArray(input) && input.length === 3 && input.every(Number.isFinite)) {
34
+ out[0] = input[0];
35
+ out[1] = input[1];
36
+ out[2] = input[2];
37
+ }
38
+ else
39
+ throw new World3DError('WORLD3D_INPUT_INVALID', 'color');
40
+ return out;
41
+ }
42
+ /**
43
+ * One material class carries the superset of surface parameters; `shading`
44
+ * selects the lighting model. Assign fields freely and call touch() when a
45
+ * change alters shader features (maps added or removed, alpha mode, side).
46
+ * Scalar and color edits take effect on the next draw without touch().
47
+ */
48
+ export class Material3D extends Resource3D {
49
+ shading;
50
+ color = new Float32Array([1, 1, 1]);
51
+ opacity = 1;
52
+ map;
53
+ side = 'front';
54
+ alphaMode = 'opaque';
55
+ /** Fragments below this alpha are discarded in 'mask' mode. */
56
+ alphaCutoff = 0.5;
57
+ /** How a blended fragment combines with what is behind it. Used only when `alphaMode` is 'blend'. */
58
+ blending = 'normal';
59
+ depthTest = true;
60
+ depthWrite = true;
61
+ /** Multiply the base color by the geometry's `color` attribute. */
62
+ vertexColors = false;
63
+ fog = true;
64
+ toneMapped = true;
65
+ visible = true;
66
+ emissive = new Float32Array([0, 0, 0]);
67
+ emissiveIntensity = 1;
68
+ emissiveMap;
69
+ normalMap;
70
+ normalScale = 1;
71
+ occlusionMap;
72
+ occlusionStrength = 1;
73
+ flatShading = false;
74
+ wireframe = false;
75
+ // Phong
76
+ specular = new Float32Array([0.07, 0.07, 0.07]);
77
+ shininess = 30;
78
+ /** Optional fragment hook. Call touch() after assigning a different shader. */
79
+ shader;
80
+ /**
81
+ * Baked lighting added to the indirect light of lit materials. It is sampled
82
+ * with the texture's `channel`, normally 1 for a second, non-overlapping UV set.
83
+ */
84
+ lightMap;
85
+ lightMapIntensity = 1;
86
+ /**
87
+ * A mirror image of the scene for a flat reflective surface on a standard
88
+ * material, normally the texture of a PlanarReflection3D. It is read at
89
+ * the pixel's own place on screen, so the mesh needs no coordinates for
90
+ * it, and it takes the place of the environment map's reflection.
91
+ */
92
+ reflectionMap;
93
+ reflectionStrength = 1;
94
+ /** How far the surface normal pushes the mirror image sideways, as a share of the screen. */
95
+ reflectionDistortion = 0.02;
96
+ /**
97
+ * For blended materials such as particles and haze: the distance over which
98
+ * the surface fades out where it comes close to the solid geometry behind
99
+ * it, instead of ending in a hard line. 0 turns the fade off.
100
+ */
101
+ softness = 0;
102
+ /**
103
+ * Ground layers blended by a weight map, for terrain: up to four tiling
104
+ * textures, each shown where its channel of `weights` (R, G, B, A) is
105
+ * strong. Weights are read with the mesh's coordinates as they are and
106
+ * layers with those coordinates times their `repeat`. The layers take
107
+ * the texture slots of map, emissiveMap, occlusionMap, metallicRoughnessMap
108
+ * and lightMap, so leave those unset. Call touch() after assigning.
109
+ */
110
+ splat;
111
+ /** Strength, 0 to 1, of a soft rim lobe for cloth and velvet on a standard material. */
112
+ sheen = 0;
113
+ sheenColor = new Float32Array([1, 1, 1]);
114
+ sheenRoughness = 0.5;
115
+ /**
116
+ * How much light passes through a standard material, 0 to 1, as for glass.
117
+ * What lies behind is drawn first and then seen through the surface,
118
+ * tinted by its color and blurred by its roughness. Such a material is
119
+ * drawn with the transparent objects whatever its alphaMode; other
120
+ * see-through and transparent objects behind it do not show through.
121
+ */
122
+ transmission = 0;
123
+ /** Index of refraction for transmission: 1 does not bend light, 1.5 is glass, 1.33 water. */
124
+ ior = 1.5;
125
+ /** How far, in world units, light travels inside a transmitting object. Zero means a thin sheet that does not bend the view. */
126
+ thickness = 0;
127
+ /** Color white light takes on after travelling `attenuationDistance` inside a transmitting object. */
128
+ attenuationColor = new Float32Array([1, 1, 1]);
129
+ attenuationDistance = Infinity;
130
+ /** Strength, 0 to 1, of a clear lacquer layer over a standard material (car paint, varnish). */
131
+ clearcoat = 0;
132
+ clearcoatRoughness = 0.1;
133
+ /** Number of light bands for toon shading. */
134
+ toonSteps = 3;
135
+ // Standard (metallic-roughness PBR)
136
+ metallic = 0;
137
+ roughness = 1;
138
+ metallicRoughnessMap;
139
+ environmentIntensity = 1;
140
+ // Sprite and point rendering
141
+ billboard = false;
142
+ /** Treat vertex positions as normalized device coordinates; used by full-screen layers. */
143
+ screenSpace = false;
144
+ sizeAttenuation = true;
145
+ rotation = 0;
146
+ pointSize = 1;
147
+ /** Polygon offset to resolve coplanar decals: [factor, units]. */
148
+ polygonOffset;
149
+ constructor(shading, options = {}) {
150
+ super();
151
+ this.shading = shading;
152
+ this.name = options.name ?? '';
153
+ if (options.color !== undefined)
154
+ setColor3D(this.color, options.color);
155
+ if (options.emissive !== undefined)
156
+ setColor3D(this.emissive, options.emissive);
157
+ this.opacity = options.opacity ?? 1;
158
+ this.map = options.map;
159
+ this.side = options.side ?? 'front';
160
+ // Additive, multiply and premultiplied blending only take effect in the blended pass, so asking for one
161
+ // is asking for that pass.
162
+ this.alphaMode =
163
+ options.alphaMode ?? (this.opacity < 1 || (options.blending ?? 'normal') !== 'normal' ? 'blend' : 'opaque');
164
+ this.alphaCutoff = options.alphaCutoff ?? 0.5;
165
+ this.blending = options.blending ?? 'normal';
166
+ this.depthTest = options.depthTest ?? true;
167
+ this.depthWrite = options.depthWrite ?? this.alphaMode !== 'blend';
168
+ this.vertexColors = options.vertexColors ?? false;
169
+ this.fog = options.fog ?? true;
170
+ this.toneMapped = options.toneMapped ?? true;
171
+ this.emissiveIntensity = options.emissiveIntensity ?? 1;
172
+ this.emissiveMap = options.emissiveMap;
173
+ this.normalMap = options.normalMap;
174
+ this.normalScale = options.normalScale ?? 1;
175
+ this.occlusionMap = options.occlusionMap;
176
+ this.occlusionStrength = options.occlusionStrength ?? 1;
177
+ this.flatShading = options.flatShading ?? false;
178
+ this.wireframe = options.wireframe ?? false;
179
+ }
180
+ /** True when the material must be drawn in the sorted transparent pass. */
181
+ get isTransparent() {
182
+ return this.alphaMode === 'blend';
183
+ }
184
+ setColor(color) {
185
+ setColor3D(this.color, color);
186
+ return this;
187
+ }
188
+ setEmissive(color) {
189
+ setColor3D(this.emissive, color);
190
+ return this;
191
+ }
192
+ /** Independent copy sharing texture references. */
193
+ clone() {
194
+ const copy = new Material3D(this.shading);
195
+ const skip = new Set(['id', 'shading', 'color', 'emissive', 'specular', 'sheenColor', 'attenuationColor']);
196
+ for (const key of Object.keys(this)) {
197
+ if (!skip.has(key))
198
+ copy[key] = this[key];
199
+ }
200
+ copy.color.set(this.color);
201
+ copy.emissive.set(this.emissive);
202
+ copy.specular.set(this.specular);
203
+ copy.sheenColor.set(this.sheenColor);
204
+ copy.attenuationColor.set(this.attenuationColor);
205
+ return copy;
206
+ }
207
+ }
208
+ /** Constant color, unaffected by lights. */
209
+ export function createUnlitMaterial3D(options = {}) {
210
+ return new Material3D('unlit', options);
211
+ }
212
+ /** Diffuse-only lighting; the cheapest lit model. */
213
+ export function createLambertMaterial3D(options = {}) {
214
+ return new Material3D('lambert', options);
215
+ }
216
+ /** Diffuse plus Blinn-Phong specular highlights. */
217
+ export function createPhongMaterial3D(options = {}) {
218
+ const material = new Material3D('phong', options);
219
+ if (options.specular !== undefined)
220
+ setColor3D(material.specular, options.specular);
221
+ material.shininess = options.shininess ?? 30;
222
+ return material;
223
+ }
224
+ /** Cel shading: diffuse light quantized into `steps` flat bands. */
225
+ export function createToonMaterial3D(options = {}) {
226
+ const material = new Material3D('toon', options);
227
+ material.toonSteps = Math.max(1, Math.floor(options.steps ?? 3));
228
+ return material;
229
+ }
230
+ /**
231
+ * Lighting baked into a sphere image: the surface color is looked up by the
232
+ * view-space normal, so no lights are needed. The image is held in `emissiveMap`.
233
+ */
234
+ export function createMatcapMaterial3D(options) {
235
+ const material = new Material3D('matcap', options);
236
+ material.emissiveMap = options.matcap;
237
+ return material;
238
+ }
239
+ /**
240
+ * A standard material set up as glass: smooth and see-through, with
241
+ * reflections kept. Give it a `thickness` to bend the view like a solid block.
242
+ */
243
+ export function createGlassMaterial3D(options = {}) {
244
+ const material = createStandardMaterial3D({ roughness: 0.05, metallic: 0, ...options });
245
+ material.transmission = options.transmission ?? 1;
246
+ material.ior = options.ior ?? 1.5;
247
+ material.thickness = options.thickness ?? 0;
248
+ return material;
249
+ }
250
+ /** Physically based metallic-roughness model, matching glTF 2.0 materials. */
251
+ export function createStandardMaterial3D(options = {}) {
252
+ const material = new Material3D('standard', options);
253
+ material.metallic = options.metallic ?? 0;
254
+ material.roughness = options.roughness ?? 1;
255
+ material.metallicRoughnessMap = options.metallicRoughnessMap;
256
+ material.environmentIntensity = options.environmentIntensity ?? 1;
257
+ return material;
258
+ }
259
+ /** Camera-facing unlit quad material for Sprite3D. */
260
+ export function createSpriteMaterial3D(options = {}) {
261
+ const material = new Material3D('unlit', { alphaMode: 'blend', side: 'double', ...options });
262
+ material.billboard = true;
263
+ material.sizeAttenuation = options.sizeAttenuation ?? true;
264
+ material.rotation = options.rotation ?? 0;
265
+ return material;
266
+ }
267
+ //# sourceMappingURL=Material3D.js.map