chorama 0.1.2 → 0.2.1

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 (483) hide show
  1. package/README.md +2 -1
  2. package/dist/index.module.js +32480 -15098
  3. package/dist/index.module.js.map +1 -1
  4. package/dist/index.umd.js +32628 -15121
  5. package/dist/index.umd.js.map +1 -1
  6. package/package.json +7 -2
  7. package/.configs/tsconfig.lib.json +0 -43
  8. package/.configs/tsconfig.website.json +0 -34
  9. package/.github/workflows/publish.yml +0 -24
  10. package/.github/workflows/static.yml +0 -57
  11. package/.vscode/launch.json +0 -29
  12. package/.vscode/tasks.json +0 -19
  13. package/assets/images/disappointed.jpg +0 -0
  14. package/assets/images/skybox/grimmnight_back.png +0 -0
  15. package/assets/images/skybox/grimmnight_bottom.png +0 -0
  16. package/assets/images/skybox/grimmnight_front.png +0 -0
  17. package/assets/images/skybox/grimmnight_left.png +0 -0
  18. package/assets/images/skybox/grimmnight_right.png +0 -0
  19. package/assets/images/skybox/grimmnight_top.png +0 -0
  20. package/assets/images/skybox/miramar_back.png +0 -0
  21. package/assets/images/skybox/miramar_bottom.png +0 -0
  22. package/assets/images/skybox/miramar_front.png +0 -0
  23. package/assets/images/skybox/miramar_left.png +0 -0
  24. package/assets/images/skybox/miramar_right.png +0 -0
  25. package/assets/images/skybox/miramar_top.png +0 -0
  26. package/assets/images/uv.jpg +0 -0
  27. package/assets/models/glb/AlphaBlendModeTest.glb +0 -0
  28. package/assets/models/glb/IridescenceLamp.glb +0 -0
  29. package/assets/models/glb/teapot.glb +0 -0
  30. package/assets/models/gltf/flight_helmet/FlightHelmet_Materials_GlassPlasticMat_BaseColor.png +0 -0
  31. package/assets/models/gltf/flight_helmet/FlightHelmet_Materials_GlassPlasticMat_Normal.png +0 -0
  32. package/assets/models/gltf/flight_helmet/FlightHelmet_Materials_GlassPlasticMat_OcclusionRoughMetal.png +0 -0
  33. package/assets/models/gltf/flight_helmet/FlightHelmet_Materials_LeatherPartsMat_BaseColor.png +0 -0
  34. package/assets/models/gltf/flight_helmet/FlightHelmet_Materials_LeatherPartsMat_Normal.png +0 -0
  35. package/assets/models/gltf/flight_helmet/FlightHelmet_Materials_LeatherPartsMat_OcclusionRoughMetal.png +0 -0
  36. package/assets/models/gltf/flight_helmet/FlightHelmet_Materials_LensesMat_BaseColor.png +0 -0
  37. package/assets/models/gltf/flight_helmet/FlightHelmet_Materials_LensesMat_Normal.png +0 -0
  38. package/assets/models/gltf/flight_helmet/FlightHelmet_Materials_LensesMat_OcclusionRoughMetal.png +0 -0
  39. package/assets/models/gltf/flight_helmet/FlightHelmet_Materials_MetalPartsMat_BaseColor.png +0 -0
  40. package/assets/models/gltf/flight_helmet/FlightHelmet_Materials_MetalPartsMat_Normal.png +0 -0
  41. package/assets/models/gltf/flight_helmet/FlightHelmet_Materials_MetalPartsMat_OcclusionRoughMetal.png +0 -0
  42. package/assets/models/gltf/flight_helmet/FlightHelmet_Materials_RubberWoodMat_BaseColor.png +0 -0
  43. package/assets/models/gltf/flight_helmet/FlightHelmet_Materials_RubberWoodMat_Normal.png +0 -0
  44. package/assets/models/gltf/flight_helmet/FlightHelmet_Materials_RubberWoodMat_OcclusionRoughMetal.png +0 -0
  45. package/assets/models/gltf/flight_helmet/index.bin +0 -0
  46. package/assets/models/gltf/flight_helmet/index.gltf +0 -705
  47. package/assets/models/gltf/object.gltf +0 -23
  48. package/assets/models/gltf/pirate_girl/index.bin +0 -0
  49. package/assets/models/gltf/pirate_girl/index.gltf +0 -2082
  50. package/assets/models/obj/pirate_girl/pirate_girl.obj +0 -18459
  51. package/assets/models/obj/pirate_girl/pirate_girl.png +0 -0
  52. package/astro.config.mjs +0 -33
  53. package/content/guide/api-map.md +0 -89
  54. package/content/guide/camera-and-controls.md +0 -98
  55. package/content/guide/first-scene.md +0 -176
  56. package/content/guide/index.md +0 -72
  57. package/content/guide/installation.md +0 -179
  58. package/content/guide/materials-and-lighting.md +0 -138
  59. package/content/guide/plugins-and-render-pipeline.md +0 -124
  60. package/content/guide/render-targets-and-views.md +0 -146
  61. package/content/guide/scene-graph-and-transforms.md +0 -113
  62. package/content/guide/textures-and-assets.md +0 -123
  63. package/content/guide/troubleshooting.md +0 -49
  64. package/dist/website/_astro/DocLayout.BsV7p0dY.css +0 -1
  65. package/dist/website/examples/camera/orthographic/example.html +0 -172
  66. package/dist/website/examples/camera/orthographic/index.html +0 -124
  67. package/dist/website/examples/camera/perspective/example.html +0 -190
  68. package/dist/website/examples/camera/perspective/index.html +0 -142
  69. package/dist/website/examples/camera/tone_mapping/example.html +0 -238
  70. package/dist/website/examples/camera/tone_mapping/index.html +0 -190
  71. package/dist/website/examples/index.html +0 -2
  72. package/dist/website/examples/lights/directional/example.html +0 -447
  73. package/dist/website/examples/lights/directional/index.html +0 -399
  74. package/dist/website/examples/lights/multiple_spot_lights/example.html +0 -356
  75. package/dist/website/examples/lights/multiple_spot_lights/index.html +0 -308
  76. package/dist/website/examples/lights/point/example.html +0 -387
  77. package/dist/website/examples/lights/point/index.html +0 -339
  78. package/dist/website/examples/lights/spot/example.html +0 -416
  79. package/dist/website/examples/lights/spot/index.html +0 -368
  80. package/dist/website/examples/loader/gltf/basic/example.html +0 -129
  81. package/dist/website/examples/loader/gltf/basic/index.html +0 -81
  82. package/dist/website/examples/loader/gltf/material/alpha-blend-mode/example.html +0 -131
  83. package/dist/website/examples/loader/gltf/material/alpha-blend-mode/index.html +0 -83
  84. package/dist/website/examples/loader/gltf/material/flight_helmet/example.html +0 -162
  85. package/dist/website/examples/loader/gltf/material/flight_helmet/index.html +0 -114
  86. package/dist/website/examples/loader/gltf/material/iridescence_lamp/example.html +0 -169
  87. package/dist/website/examples/loader/gltf/material/iridescence_lamp/index.html +0 -121
  88. package/dist/website/examples/loader/objloader/example.html +0 -144
  89. package/dist/website/examples/loader/objloader/index.html +0 -96
  90. package/dist/website/examples/material/cullface/example.html +0 -163
  91. package/dist/website/examples/material/cullface/index.html +0 -115
  92. package/dist/website/examples/material/materials/example.html +0 -175
  93. package/dist/website/examples/material/materials/index.html +0 -127
  94. package/dist/website/examples/material/standard/basic/example.html +0 -212
  95. package/dist/website/examples/material/standard/basic/index.html +0 -164
  96. package/dist/website/examples/material/standard/reflection_refraction/example.html +0 -241
  97. package/dist/website/examples/material/standard/reflection_refraction/index.html +0 -193
  98. package/dist/website/examples/mesh/capsule/example.html +0 -173
  99. package/dist/website/examples/mesh/capsule/index.html +0 -125
  100. package/dist/website/examples/mesh/circle/example.html +0 -173
  101. package/dist/website/examples/mesh/circle/index.html +0 -125
  102. package/dist/website/examples/mesh/cone/example.html +0 -180
  103. package/dist/website/examples/mesh/cone/index.html +0 -132
  104. package/dist/website/examples/mesh/cuboid/example.html +0 -207
  105. package/dist/website/examples/mesh/cuboid/index.html +0 -159
  106. package/dist/website/examples/mesh/cylinder/example.html +0 -195
  107. package/dist/website/examples/mesh/cylinder/index.html +0 -147
  108. package/dist/website/examples/mesh/dodecahedron/example.html +0 -158
  109. package/dist/website/examples/mesh/dodecahedron/index.html +0 -110
  110. package/dist/website/examples/mesh/ellipsoid/example.html +0 -179
  111. package/dist/website/examples/mesh/ellipsoid/index.html +0 -131
  112. package/dist/website/examples/mesh/extrude/example.html +0 -169
  113. package/dist/website/examples/mesh/extrude/index.html +0 -121
  114. package/dist/website/examples/mesh/frustum/example.html +0 -185
  115. package/dist/website/examples/mesh/frustum/index.html +0 -137
  116. package/dist/website/examples/mesh/helix/example.html +0 -184
  117. package/dist/website/examples/mesh/helix/index.html +0 -136
  118. package/dist/website/examples/mesh/icosahedron/example.html +0 -158
  119. package/dist/website/examples/mesh/icosahedron/index.html +0 -110
  120. package/dist/website/examples/mesh/icosphere/example.html +0 -163
  121. package/dist/website/examples/mesh/icosphere/index.html +0 -115
  122. package/dist/website/examples/mesh/lathe/example.html +0 -175
  123. package/dist/website/examples/mesh/lathe/index.html +0 -127
  124. package/dist/website/examples/mesh/meshTopology/example.html +0 -210
  125. package/dist/website/examples/mesh/meshTopology/index.html +0 -162
  126. package/dist/website/examples/mesh/octahedron/example.html +0 -158
  127. package/dist/website/examples/mesh/octahedron/index.html +0 -110
  128. package/dist/website/examples/mesh/plane/example.html +0 -173
  129. package/dist/website/examples/mesh/plane/index.html +0 -125
  130. package/dist/website/examples/mesh/prism/example.html +0 -173
  131. package/dist/website/examples/mesh/prism/index.html +0 -125
  132. package/dist/website/examples/mesh/pyramid/example.html +0 -172
  133. package/dist/website/examples/mesh/pyramid/index.html +0 -124
  134. package/dist/website/examples/mesh/ring/example.html +0 -173
  135. package/dist/website/examples/mesh/ring/index.html +0 -125
  136. package/dist/website/examples/mesh/skinning/example.html +0 -187
  137. package/dist/website/examples/mesh/skinning/index.html +0 -139
  138. package/dist/website/examples/mesh/terrain/example.html +0 -214
  139. package/dist/website/examples/mesh/terrain/index.html +0 -166
  140. package/dist/website/examples/mesh/tetrahedron/example.html +0 -158
  141. package/dist/website/examples/mesh/tetrahedron/index.html +0 -110
  142. package/dist/website/examples/mesh/torus/example.html +0 -173
  143. package/dist/website/examples/mesh/torus/index.html +0 -125
  144. package/dist/website/examples/mesh/torus-knot/example.html +0 -188
  145. package/dist/website/examples/mesh/torus-knot/index.html +0 -140
  146. package/dist/website/examples/mesh/tube/example.html +0 -180
  147. package/dist/website/examples/mesh/tube/index.html +0 -132
  148. package/dist/website/examples/mesh/uvsphere/example.html +0 -169
  149. package/dist/website/examples/mesh/uvsphere/index.html +0 -121
  150. package/dist/website/examples/mesh/wedge/example.html +0 -168
  151. package/dist/website/examples/mesh/wedge/index.html +0 -120
  152. package/dist/website/examples/other/rotatingCube/example.html +0 -142
  153. package/dist/website/examples/other/rotatingCube/index.html +0 -94
  154. package/dist/website/examples/other/rotatingSphere/example.html +0 -144
  155. package/dist/website/examples/other/rotatingSphere/index.html +0 -96
  156. package/dist/website/examples/rendertarget/basic_canvas/example.html +0 -178
  157. package/dist/website/examples/rendertarget/basic_canvas/index.html +0 -130
  158. package/dist/website/examples/rendertarget/depth_texture/example.html +0 -188
  159. package/dist/website/examples/rendertarget/depth_texture/index.html +0 -140
  160. package/dist/website/examples/rendertarget/image_target/example.html +0 -196
  161. package/dist/website/examples/rendertarget/image_target/index.html +0 -148
  162. package/dist/website/examples/rendertarget/multiple_views/example.html +0 -204
  163. package/dist/website/examples/rendertarget/multiple_views/index.html +0 -156
  164. package/dist/website/examples/rendertarget/render_masks/example.html +0 -222
  165. package/dist/website/examples/rendertarget/render_masks/index.html +0 -174
  166. package/dist/website/examples/rendertarget/split_screen/example.html +0 -178
  167. package/dist/website/examples/rendertarget/split_screen/index.html +0 -130
  168. package/dist/website/examples/rendertarget/split_view/example.html +0 -191
  169. package/dist/website/examples/rendertarget/split_view/index.html +0 -143
  170. package/dist/website/examples/skybox/skybox/example.html +0 -162
  171. package/dist/website/examples/skybox/skybox/index.html +0 -114
  172. package/dist/website/examples/texture/arrays/example.html +0 -204
  173. package/dist/website/examples/texture/arrays/index.html +0 -156
  174. package/dist/website/examples/texture/textureWrap/example.html +0 -169
  175. package/dist/website/examples/texture/textureWrap/index.html +0 -121
  176. package/dist/website/examples/transform/propagation/example.html +0 -141
  177. package/dist/website/examples/transform/propagation/index.html +0 -93
  178. package/dist/website/guide/api-map/index.html +0 -82
  179. package/dist/website/guide/camera-and-controls/index.html +0 -62
  180. package/dist/website/guide/first-scene/index.html +0 -119
  181. package/dist/website/guide/index.html +0 -58
  182. package/dist/website/guide/installation/index.html +0 -133
  183. package/dist/website/guide/materials-and-lighting/index.html +0 -90
  184. package/dist/website/guide/plugins-and-render-pipeline/index.html +0 -89
  185. package/dist/website/guide/render-targets-and-views/index.html +0 -95
  186. package/dist/website/guide/scene-graph-and-transforms/index.html +0 -69
  187. package/dist/website/guide/textures-and-assets/index.html +0 -85
  188. package/dist/website/guide/troubleshooting/index.html +0 -39
  189. package/dist/website/images/disappointed.jpg +0 -0
  190. package/dist/website/images/skybox/grimmnight_back.png +0 -0
  191. package/dist/website/images/skybox/grimmnight_bottom.png +0 -0
  192. package/dist/website/images/skybox/grimmnight_front.png +0 -0
  193. package/dist/website/images/skybox/grimmnight_left.png +0 -0
  194. package/dist/website/images/skybox/grimmnight_right.png +0 -0
  195. package/dist/website/images/skybox/grimmnight_top.png +0 -0
  196. package/dist/website/images/skybox/miramar_back.png +0 -0
  197. package/dist/website/images/skybox/miramar_bottom.png +0 -0
  198. package/dist/website/images/skybox/miramar_front.png +0 -0
  199. package/dist/website/images/skybox/miramar_left.png +0 -0
  200. package/dist/website/images/skybox/miramar_right.png +0 -0
  201. package/dist/website/images/skybox/miramar_top.png +0 -0
  202. package/dist/website/images/uv.jpg +0 -0
  203. package/dist/website/index.html +0 -157
  204. package/dist/website/models/glb/AlphaBlendModeTest.glb +0 -0
  205. package/dist/website/models/glb/IridescenceLamp.glb +0 -0
  206. package/dist/website/models/glb/teapot.glb +0 -0
  207. package/dist/website/models/gltf/flight_helmet/FlightHelmet_Materials_GlassPlasticMat_BaseColor.png +0 -0
  208. package/dist/website/models/gltf/flight_helmet/FlightHelmet_Materials_GlassPlasticMat_Normal.png +0 -0
  209. package/dist/website/models/gltf/flight_helmet/FlightHelmet_Materials_GlassPlasticMat_OcclusionRoughMetal.png +0 -0
  210. package/dist/website/models/gltf/flight_helmet/FlightHelmet_Materials_LeatherPartsMat_BaseColor.png +0 -0
  211. package/dist/website/models/gltf/flight_helmet/FlightHelmet_Materials_LeatherPartsMat_Normal.png +0 -0
  212. package/dist/website/models/gltf/flight_helmet/FlightHelmet_Materials_LeatherPartsMat_OcclusionRoughMetal.png +0 -0
  213. package/dist/website/models/gltf/flight_helmet/FlightHelmet_Materials_LensesMat_BaseColor.png +0 -0
  214. package/dist/website/models/gltf/flight_helmet/FlightHelmet_Materials_LensesMat_Normal.png +0 -0
  215. package/dist/website/models/gltf/flight_helmet/FlightHelmet_Materials_LensesMat_OcclusionRoughMetal.png +0 -0
  216. package/dist/website/models/gltf/flight_helmet/FlightHelmet_Materials_MetalPartsMat_BaseColor.png +0 -0
  217. package/dist/website/models/gltf/flight_helmet/FlightHelmet_Materials_MetalPartsMat_Normal.png +0 -0
  218. package/dist/website/models/gltf/flight_helmet/FlightHelmet_Materials_MetalPartsMat_OcclusionRoughMetal.png +0 -0
  219. package/dist/website/models/gltf/flight_helmet/FlightHelmet_Materials_RubberWoodMat_BaseColor.png +0 -0
  220. package/dist/website/models/gltf/flight_helmet/FlightHelmet_Materials_RubberWoodMat_Normal.png +0 -0
  221. package/dist/website/models/gltf/flight_helmet/FlightHelmet_Materials_RubberWoodMat_OcclusionRoughMetal.png +0 -0
  222. package/dist/website/models/gltf/flight_helmet/index.bin +0 -0
  223. package/dist/website/models/gltf/flight_helmet/index.gltf +0 -705
  224. package/dist/website/models/gltf/object.gltf +0 -23
  225. package/dist/website/models/gltf/pirate_girl/index.bin +0 -0
  226. package/dist/website/models/gltf/pirate_girl/index.gltf +0 -2082
  227. package/dist/website/models/obj/pirate_girl/pirate_girl.obj +0 -18459
  228. package/dist/website/models/obj/pirate_girl/pirate_girl.png +0 -0
  229. package/env.d.ts +0 -5
  230. package/examples/camera/orthographic.js +0 -121
  231. package/examples/camera/perspective.js +0 -139
  232. package/examples/camera/tone_mapping.js +0 -187
  233. package/examples/lights/directional.js +0 -396
  234. package/examples/lights/multiple_spot_lights.js +0 -305
  235. package/examples/lights/point.js +0 -336
  236. package/examples/lights/spot.js +0 -365
  237. package/examples/loader/gltf/basic.js +0 -78
  238. package/examples/loader/gltf/material/alpha-blend-mode.js +0 -80
  239. package/examples/loader/gltf/material/flight_helmet.js +0 -111
  240. package/examples/loader/gltf/material/iridescence_lamp.js +0 -118
  241. package/examples/loader/objloader.js +0 -93
  242. package/examples/material/cullface.js +0 -112
  243. package/examples/material/materials.js +0 -124
  244. package/examples/material/standard/basic.js +0 -161
  245. package/examples/material/standard/reflection_refraction.js +0 -190
  246. package/examples/mesh/capsule.js +0 -122
  247. package/examples/mesh/circle.js +0 -122
  248. package/examples/mesh/cone.js +0 -129
  249. package/examples/mesh/cuboid.js +0 -156
  250. package/examples/mesh/cylinder.js +0 -144
  251. package/examples/mesh/dodecahedron.js +0 -107
  252. package/examples/mesh/ellipsoid.js +0 -128
  253. package/examples/mesh/extrude.js +0 -118
  254. package/examples/mesh/frustum.js +0 -134
  255. package/examples/mesh/helix.js +0 -133
  256. package/examples/mesh/icosahedron.js +0 -107
  257. package/examples/mesh/icosphere.js +0 -112
  258. package/examples/mesh/lathe.js +0 -124
  259. package/examples/mesh/meshTopology.js +0 -159
  260. package/examples/mesh/octahedron.js +0 -107
  261. package/examples/mesh/plane.js +0 -122
  262. package/examples/mesh/prism.js +0 -122
  263. package/examples/mesh/pyramid.js +0 -121
  264. package/examples/mesh/ring.js +0 -122
  265. package/examples/mesh/skinning.js +0 -136
  266. package/examples/mesh/terrain.js +0 -163
  267. package/examples/mesh/tetrahedron.js +0 -107
  268. package/examples/mesh/torus-knot.js +0 -137
  269. package/examples/mesh/torus.js +0 -122
  270. package/examples/mesh/tube.js +0 -129
  271. package/examples/mesh/uvsphere.js +0 -118
  272. package/examples/mesh/wedge.js +0 -117
  273. package/examples/other/rotatingCube.js +0 -91
  274. package/examples/other/rotatingSphere.js +0 -93
  275. package/examples/rendertarget/basic_canvas.js +0 -127
  276. package/examples/rendertarget/depth_texture.js +0 -137
  277. package/examples/rendertarget/image_target.js +0 -145
  278. package/examples/rendertarget/multiple_views.js +0 -153
  279. package/examples/rendertarget/render_masks.js +0 -171
  280. package/examples/rendertarget/split_screen.js +0 -127
  281. package/examples/rendertarget/split_view.js +0 -140
  282. package/examples/skybox/skybox.js +0 -111
  283. package/examples/texture/arrays.js +0 -153
  284. package/examples/texture/textureWrap.js +0 -118
  285. package/examples/transform/propagation.js +0 -90
  286. package/rollup.config.js +0 -66
  287. package/src/caches/cache.js +0 -359
  288. package/src/caches/index.js +0 -2
  289. package/src/caches/uniformbuffers.js +0 -93
  290. package/src/cameracontrols/index.js +0 -258
  291. package/src/constants/index.js +0 -3
  292. package/src/constants/mesh.js +0 -197
  293. package/src/constants/others.js +0 -218
  294. package/src/constants/texture.js +0 -183
  295. package/src/content.config.js +0 -1
  296. package/src/core/constants.js +0 -14
  297. package/src/core/extensions.js +0 -42
  298. package/src/core/index.js +0 -7
  299. package/src/core/layouts/bindgroup.js +0 -167
  300. package/src/core/layouts/index.js +0 -6
  301. package/src/core/layouts/meshvertex.js +0 -60
  302. package/src/core/layouts/pipeline.js +0 -165
  303. package/src/core/layouts/uniform.js +0 -21
  304. package/src/core/layouts/uniformbuffer.js +0 -23
  305. package/src/core/layouts/vertexbuffer.js +0 -43
  306. package/src/core/limits.js +0 -247
  307. package/src/core/resources/blendparams.js +0 -89
  308. package/src/core/resources/gpubuffer.js +0 -53
  309. package/src/core/resources/gpumesh.js +0 -76
  310. package/src/core/resources/gpusampler.js +0 -43
  311. package/src/core/resources/gputexture.js +0 -102
  312. package/src/core/resources/index.js +0 -7
  313. package/src/core/resources/newuniformbuffer.js +0 -58
  314. package/src/core/resources/webglshadermodule.js +0 -58
  315. package/src/core/shader.js +0 -75
  316. package/src/core/webgl/bindgroup.js +0 -247
  317. package/src/core/webgl/descriptors.js +0 -166
  318. package/src/core/webgl/gpuqueue.js +0 -63
  319. package/src/core/webgl/index.js +0 -8
  320. package/src/core/webgl/renderpassencoder.js +0 -783
  321. package/src/core/webgl/renderpipeline.js +0 -91
  322. package/src/core/webgl/utils.js +0 -521
  323. package/src/core/webgl/webglrenderdevice.js +0 -259
  324. package/src/function.js +0 -358
  325. package/src/index.js +0 -15
  326. package/src/loader/gltf.js +0 -2722
  327. package/src/loader/index.js +0 -3
  328. package/src/loader/loader.js +0 -174
  329. package/src/loader/obj.js +0 -188
  330. package/src/loader/texture.js +0 -138
  331. package/src/loader/utils.js +0 -60
  332. package/src/material/alphablend.js +0 -21
  333. package/src/material/basic.js +0 -89
  334. package/src/material/depth.js +0 -87
  335. package/src/material/index.js +0 -9
  336. package/src/material/lambert.js +0 -87
  337. package/src/material/material.js +0 -148
  338. package/src/material/normal.js +0 -44
  339. package/src/material/phong.js +0 -100
  340. package/src/material/raw.js +0 -71
  341. package/src/material/standard.js +0 -309
  342. package/src/math/index.js +0 -3
  343. package/src/math/transform.js +0 -38
  344. package/src/mesh/attribute/attribute.js +0 -79
  345. package/src/mesh/attribute/index.js +0 -1
  346. package/src/mesh/attributedata/index.js +0 -1
  347. package/src/mesh/attributedata/separate.js +0 -180
  348. package/src/mesh/builders/base.js +0 -41
  349. package/src/mesh/builders/capsule.js +0 -47
  350. package/src/mesh/builders/circle.js +0 -63
  351. package/src/mesh/builders/cone.js +0 -29
  352. package/src/mesh/builders/cuboid.js +0 -135
  353. package/src/mesh/builders/cylinder.js +0 -131
  354. package/src/mesh/builders/dodecahedron.js +0 -130
  355. package/src/mesh/builders/ellipsoid.js +0 -65
  356. package/src/mesh/builders/extrude.js +0 -136
  357. package/src/mesh/builders/frustum.js +0 -26
  358. package/src/mesh/builders/geometry.js +0 -121
  359. package/src/mesh/builders/helix.js +0 -35
  360. package/src/mesh/builders/icosahedron.js +0 -61
  361. package/src/mesh/builders/icosphere.js +0 -141
  362. package/src/mesh/builders/index.js +0 -28
  363. package/src/mesh/builders/lathe.js +0 -85
  364. package/src/mesh/builders/octahedron.js +0 -43
  365. package/src/mesh/builders/plane.js +0 -73
  366. package/src/mesh/builders/polyhedron.js +0 -121
  367. package/src/mesh/builders/prism.js +0 -19
  368. package/src/mesh/builders/pyramid.js +0 -90
  369. package/src/mesh/builders/ring.js +0 -109
  370. package/src/mesh/builders/surfaces.js +0 -69
  371. package/src/mesh/builders/terrain.js +0 -80
  372. package/src/mesh/builders/tetrahedron.js +0 -37
  373. package/src/mesh/builders/torusknot.js +0 -36
  374. package/src/mesh/builders/tube.js +0 -209
  375. package/src/mesh/builders/utils.js +0 -148
  376. package/src/mesh/builders/uvsphere.js +0 -80
  377. package/src/mesh/builders/wedge.js +0 -22
  378. package/src/mesh/builders/wireframe.js +0 -62
  379. package/src/mesh/index.js +0 -4
  380. package/src/mesh/mesh.js +0 -157
  381. package/src/objects/bone.js +0 -17
  382. package/src/objects/camera/camera.js +0 -159
  383. package/src/objects/camera/index.js +0 -2
  384. package/src/objects/camera/projection.js +0 -203
  385. package/src/objects/debug/index.js +0 -1
  386. package/src/objects/debug/skeleton.js +0 -28
  387. package/src/objects/index.js +0 -7
  388. package/src/objects/light/ambient.js +0 -41
  389. package/src/objects/light/directional.js +0 -51
  390. package/src/objects/light/index.js +0 -5
  391. package/src/objects/light/point.js +0 -56
  392. package/src/objects/light/shadow/index.js +0 -1
  393. package/src/objects/light/shadow/shadow.js +0 -67
  394. package/src/objects/light/spot.js +0 -82
  395. package/src/objects/mesh.js +0 -89
  396. package/src/objects/object3d.js +0 -167
  397. package/src/objects/skybox.js +0 -38
  398. package/src/plugins/camera/RenderTarget2DPool.js +0 -94
  399. package/src/plugins/camera/camera.js +0 -27
  400. package/src/plugins/camera/index.js +0 -4
  401. package/src/plugins/camera/nodes/canvasblit.js +0 -153
  402. package/src/plugins/camera/nodes/index.js +0 -5
  403. package/src/plugins/camera/nodes/opaquepass.js +0 -94
  404. package/src/plugins/camera/nodes/tonemapping.js +0 -217
  405. package/src/plugins/camera/nodes/transparentpass.js +0 -87
  406. package/src/plugins/camera/nodes/view.js +0 -72
  407. package/src/plugins/camera/resources/cameracolortargets.js +0 -66
  408. package/src/plugins/camera/resources/canvasblitpipeline.js +0 -6
  409. package/src/plugins/camera/resources/index.js +0 -3
  410. package/src/plugins/camera/resources/tonemappingpipeline.js +0 -6
  411. package/src/plugins/index.js +0 -6
  412. package/src/plugins/light/index.js +0 -2
  413. package/src/plugins/light/light.js +0 -19
  414. package/src/plugins/light/nodes/index.js +0 -1
  415. package/src/plugins/light/nodes/light.js +0 -127
  416. package/src/plugins/meshmaterial/index.js +0 -3
  417. package/src/plugins/meshmaterial/meshmaterial.js +0 -644
  418. package/src/plugins/meshmaterial/nodes/index.js +0 -1
  419. package/src/plugins/meshmaterial/nodes/meshmaterial.js +0 -83
  420. package/src/plugins/meshmaterial/resources/bonetexture.js +0 -176
  421. package/src/plugins/meshmaterial/resources/environmentmap.js +0 -44
  422. package/src/plugins/meshmaterial/resources/index.js +0 -5
  423. package/src/plugins/meshmaterial/resources/materialuniformbuffers.js +0 -94
  424. package/src/plugins/meshmaterial/resources/meshmaterialbindgroups.js +0 -40
  425. package/src/plugins/meshmaterial/resources/meshmaterialpipelines.js +0 -50
  426. package/src/plugins/shadow/index.js +0 -3
  427. package/src/plugins/shadow/nodes/index.js +0 -3
  428. package/src/plugins/shadow/nodes/occluder.js +0 -106
  429. package/src/plugins/shadow/nodes/opaquePass.js +0 -110
  430. package/src/plugins/shadow/nodes/view.js +0 -272
  431. package/src/plugins/shadow/resources/ShadowMap.js +0 -99
  432. package/src/plugins/shadow/resources/index.js +0 -2
  433. package/src/plugins/shadow/resources/shadowpipelines.js +0 -25
  434. package/src/plugins/shadow/shadow.js +0 -26
  435. package/src/plugins/skeletonhelper/index.js +0 -1
  436. package/src/plugins/skeletonhelper/skeletonhelper.js +0 -202
  437. package/src/plugins/skybox/index.js +0 -3
  438. package/src/plugins/skybox/nodes/index.js +0 -1
  439. package/src/plugins/skybox/nodes/skybox.js +0 -335
  440. package/src/plugins/skybox/resources/index.js +0 -2
  441. package/src/plugins/skybox/resources/skyboxmesh.js +0 -14
  442. package/src/plugins/skybox/resources/skyboxpipeline.js +0 -16
  443. package/src/plugins/skybox/skybox.js +0 -18
  444. package/src/renderer/core/index.js +0 -293
  445. package/src/renderer/graph/index.js +0 -3
  446. package/src/renderer/graph/nodes.js +0 -34
  447. package/src/renderer/graph/rendergraph.js +0 -182
  448. package/src/renderer/index.js +0 -5
  449. package/src/renderer/plugin.js +0 -16
  450. package/src/renderer/renderer.js +0 -195
  451. package/src/renderer/views.js +0 -28
  452. package/src/rendertarget/canvastarget.js +0 -33
  453. package/src/rendertarget/image.js +0 -132
  454. package/src/rendertarget/index.js +0 -3
  455. package/src/rendertarget/rendertarget.js +0 -89
  456. package/src/shader/basicFragment.glsl +0 -38
  457. package/src/shader/basicVertex.glsl +0 -98
  458. package/src/shader/blitFragment.glsl +0 -9
  459. package/src/shader/common/color.glsl +0 -7
  460. package/src/shader/common/common.glsl +0 -54
  461. package/src/shader/common/index.js +0 -5
  462. package/src/shader/common/light.glsl +0 -437
  463. package/src/shader/common/math.glsl +0 -12
  464. package/src/shader/common/tonemap.glsl +0 -118
  465. package/src/shader/debug/index.js +0 -2
  466. package/src/shader/debug/skeletonFragment.glsl +0 -6
  467. package/src/shader/debug/skeletonVertex.glsl +0 -25
  468. package/src/shader/depthFragment.glsl +0 -34
  469. package/src/shader/fullscreenVertex.glsl +0 -26
  470. package/src/shader/index.js +0 -14
  471. package/src/shader/lambertFragment.glsl +0 -134
  472. package/src/shader/normalFragment.glsl +0 -22
  473. package/src/shader/phongFragment.glsl +0 -148
  474. package/src/shader/skyboxFragment.glsl +0 -16
  475. package/src/shader/skyboxVertex.glsl +0 -21
  476. package/src/shader/standardFragment.glsl +0 -331
  477. package/src/shader/tonemappingFragment.glsl +0 -37
  478. package/src/texture/index.js +0 -2
  479. package/src/texture/sampler.js +0 -191
  480. package/src/texture/texture.js +0 -438
  481. package/src/utils/index.js +0 -129
  482. package/src/utils/rendergraph_gui.js +0 -583
  483. package/tsconfig.json +0 -11
@@ -1,138 +0,0 @@
1
- ---
2
- title: "Materials and Lighting"
3
- ---
4
-
5
- # Materials and Lighting
6
-
7
- This guide assumes you already have a working scene from [First Scene](/guide/first-scene).
8
- Here, you will add lit materials and light objects in small steps.
9
-
10
- ## What You Will Add
11
-
12
- - a material choice based on visual style
13
- - renderer plugins required for lighting
14
- - ambient light for base visibility
15
- - one direct light source
16
- - a render list that includes lights
17
-
18
- ## Step 1: Import Material and Light APIs
19
-
20
- ```js
21
- import {
22
- BasicMaterial,
23
- LambertMaterial,
24
- PhongMaterial,
25
- StandardMaterial,
26
- AmbientLight,
27
- DirectionalLight,
28
- LightPlugin
29
- } from "chorama";
30
- ```
31
-
32
- Use `BasicMaterial` when you do not need scene lighting.
33
- Use `LambertMaterial`, `PhongMaterial`, or `StandardMaterial` when you want lights to affect the surface.
34
-
35
- ## Step 2: Pick a Material Model
36
-
37
- ```js
38
- const basic = new BasicMaterial();
39
- const lambert = new LambertMaterial();
40
- const phong = new PhongMaterial();
41
- const standard = new StandardMaterial({ roughness: 0.5, metallic: 0.1 });
42
- ```
43
-
44
- Quick guidance:
45
-
46
- - `BasicMaterial`: unlit shading
47
- - `LambertMaterial`: diffuse lit shading
48
- - `PhongMaterial`: diffuse + specular highlight shading
49
- - `StandardMaterial`: physically-based roughness/metallic shasing
50
-
51
- For a first lit scene, start with `LambertMaterial`.
52
-
53
- ## Step 3: Apply the Material to Your Mesh Object
54
-
55
- ```js
56
- const object = new MeshMaterial3D(mesh, lambert);
57
- ```
58
- The second parameter can be any of the materials shown in the previous step.
59
- If you keep `BasicMaterial` as the material of the object, lights will not change the object's appearance.
60
-
61
- ## Step 4: Enable the Lighting Pipeline in the Renderer
62
-
63
- ```js
64
- const renderer = new WebGLRenderer({
65
- plugins: [
66
- new LightPlugin(),
67
- new MeshMaterialPlugin(),
68
- new CameraPlugin()
69
- ]
70
- });
71
- ```
72
-
73
- `LightPlugin` must be present on the renderer for lit materials to respond to lights.
74
-
75
- ## Step 5: Add Ambient Light
76
-
77
- ```js
78
- const ambient = new AmbientLight();
79
- ambient.intensity = 0.15;
80
- ```
81
-
82
- Ambient light gives a soft base so unlit sides are still visible.
83
- It is used to approximate indirect lighting for the entire scene.
84
- Keep this low so directional/point/spot lights can affect the object's appearance.
85
-
86
- ## Step 6: Add a Directional Light
87
-
88
- ```js
89
- const sun = new DirectionalLight();
90
- sun.intensity = 1.0;
91
- sun.transform.orientation.rotateX(-Math.PI / 4);
92
- sun.transform.orientation.rotateZ(-Math.PI / 4);
93
- ```
94
-
95
- Directional light is a good first light because it is simple and predictable.
96
- It behaves like a distant light source with parallel rays. In this case, the light
97
- will point downwards onto the scene.
98
-
99
- ## Step 7: Render with Object, Lights, and Camera
100
-
101
- ```js
102
- renderer.render([object, ambient, sun, camera], device);
103
- ```
104
-
105
- Your render list must include light objects each frame.
106
- If lights are missing from the list, lit materials may look black or flat.
107
-
108
- ## Step 8: Animate and Keep Scene Responsive
109
-
110
- ```js
111
- function frame() {
112
- renderer.render([object, ambient, sun, camera], device);
113
- requestAnimationFrame(frame);
114
- }
115
-
116
- requestAnimationFrame(frame);
117
- ```
118
-
119
- Keep your existing resize handler from [First Scene](/guide/first-scene).
120
- Perspective scenes still require `camera.projection.aspect` updates on resize.
121
-
122
- ## Switching Between Material Types
123
-
124
- You can swap material at runtime to compare look and performance:
125
-
126
- ```js
127
- object.material = phong;
128
- // object.material = standard;
129
- // object.material = lambert;
130
- ```
131
-
132
- ## Reference Examples
133
-
134
- - [Directional Light](/examples/lights/directional)
135
- - [Point Light](/examples/lights/point)
136
- - [Spot Light](/examples/lights/spot)
137
-
138
- After this works, continue with [Textures and Assets](/guide/textures-and-assets)
@@ -1,124 +0,0 @@
1
- ---
2
- title: "Plugins and Render Pipeline"
3
- ---
4
-
5
- # Plugins and Render Pipeline
6
-
7
- This renderer is plugin-driven.
8
- Plugins discover scene objects, prepare render data, and contribute render work.
9
-
10
- ## What You Will Add
11
-
12
- - a plugin stack for your renderer
13
- - a clear plugin order strategy
14
-
15
- ## Step 1: Import Core Renderer and Plugins
16
-
17
- ```js
18
- import {
19
- WebGLRenderer,
20
- CameraPlugin,
21
- MeshMaterialPlugin,
22
- LightPlugin,
23
- ShadowPlugin,
24
- SkyboxPlugin
25
- } from "chorama";
26
- ```
27
-
28
- Start with the smallest plugin set your scene needs.
29
- Add others only when features require them.
30
-
31
- ## Step 2: Build a Minimal Plugin Stack
32
-
33
- ```js
34
- const renderer = new WebGLRenderer({
35
- plugins: [
36
- new MeshMaterialPlugin(),
37
- new CameraPlugin()
38
- ]
39
- });
40
- ```
41
-
42
- This stack is enough for camera + mesh/material scenes without lighting.
43
-
44
- ## Step 3: Add Lighting Support
45
-
46
- ```js
47
- const renderer = new WebGLRenderer({
48
- plugins: [
49
- new LightPlugin(),
50
- new MeshMaterialPlugin(),
51
- new CameraPlugin()
52
- ]
53
- });
54
- ```
55
-
56
- `LightPlugin` provides light uniform data for lit shaders.
57
- Without it, lit materials may render incorrectly.
58
-
59
- ## Step 4: Add Shadows and Skybox When Needed
60
-
61
- ```js
62
- const renderer = new WebGLRenderer({
63
- plugins: [
64
- new ShadowPlugin(),
65
- new LightPlugin(),
66
- new SkyboxPlugin(),
67
- new MeshMaterialPlugin(),
68
- new CameraPlugin()
69
- ]
70
- });
71
- ```
72
-
73
- Use this fuller stack only when your scene needs shadows/skybox.
74
- It is heavier than the minimal stack.
75
-
76
- ## Step 5: Render as Usual
77
-
78
- ```js
79
- renderer.render(objects, device);
80
- ```
81
-
82
- The pipeline stays behind this single call.
83
- You choose behavior by changing plugins and scene objects.
84
-
85
- ## What Happens During `render()`
86
-
87
- High-level flow:
88
-
89
- 1. Object transforms are updated through scene traversal.
90
- 2. Each plugin preprocesses scene data.
91
- 3. Plugins contribute views/render items.
92
- 4. Views are sorted and rendered.
93
-
94
- This is why missing plugins often look like "nothing happens" rather than hard errors.
95
-
96
- ## Plugin Roles
97
-
98
- - `CameraPlugin`: creates camera views and per-view camera data.
99
- - `MeshMaterialPlugin`: converts `MeshMaterial3D` objects into draw items.
100
- - `LightPlugin`: collects light objects and uploads light blocks.
101
- - `ShadowPlugin`: builds shadow passes/resources for shadow-casting lights.
102
- - `SkyboxPlugin`: adds skybox rendering behavior.
103
-
104
- ## Create a Custom Plugin
105
-
106
- ```js
107
- class MyPlugin extends Plugin {
108
- init(renderer) {
109
- // register resources, shader defines, or view fillers
110
- }
111
-
112
- preprocess(objects, device, renderer) {
113
- // inspect scene, prepare data, push views/resources
114
- }
115
-
116
- getRenderItem(object, device, renderer) {
117
- // return a render item for supported object types
118
- return undefined;
119
- }
120
- }
121
- ```
122
-
123
- A custom plugin should solve one focused concern.
124
- Avoid mixing unrelated responsibilities in one plugin.
@@ -1,146 +0,0 @@
1
- ---
2
- title: "Render Targets and Views"
3
- ---
4
-
5
- # Render Targets and Views
6
-
7
- This guide assumes you already have a scene rendering from [First Scene](/guide/first-scene).
8
- Here, we focus on where the camera renders and how to split output.
9
-
10
- ## What You Will Add
11
-
12
- - a canvas render target
13
- - an offscreen image render target
14
- - viewport/scissor based view layouts
15
-
16
- ## Step 1: Import Render Target APIs
17
-
18
- ```js
19
- import {
20
- CanvasTarget,
21
- ImageRenderTarget,
22
- ViewRectangle,
23
- Texture,
24
- TextureType,
25
- TextureFormat,
26
- Camera
27
- } from "chorama";
28
- ```
29
-
30
- Use `CanvasTarget` for on-screen output.
31
- Use `ImageRenderTarget` for offscreen passes.
32
-
33
- ## Step 2: Create a Canvas Target (Most Common)
34
-
35
- ```js
36
- const canvasTarget = new CanvasTarget(canvas);
37
- const camera = new Camera(canvasTarget);
38
- ```
39
-
40
- This is the default path for rendering directly to the page.
41
-
42
- ## Step 3: Render a Scene to the Canvas Target
43
-
44
- ```js
45
- renderer.render([object, camera], device);
46
- ```
47
-
48
- If your scene is blank, first confirm the camera uses the expected target.
49
-
50
- ## Step 4: Create an Offscreen Image Target
51
-
52
- ```js
53
- const imageTarget = new ImageRenderTarget({
54
- width: 1024,
55
- height: 1024,
56
- color: [
57
- new Texture({
58
- type: TextureType.Texture2D,
59
- format: TextureFormat.RGBA8Unorm,
60
- width: 1024,
61
- height: 1024
62
- })
63
- ],
64
- internalDepthStencil: TextureFormat.Depth24PlusStencil8
65
- });
66
- ```
67
-
68
- This creates a texture-backed target you can render into.
69
-
70
- ## Step 5: Render Offscreen with a Dedicated Camera
71
-
72
- ```js
73
- const offscreenCamera = new Camera(imageTarget);
74
- renderer.render([offscreenObject, offscreenCamera], device);
75
- ```
76
-
77
- Use a separate camera when offscreen pass framing differs from main pass.
78
-
79
- ## Step 6: Use Offscreen Output as a Texture
80
-
81
- ```js
82
- const screenObject = new MeshMaterial3D(
83
- mesh,
84
- new BasicMaterial({ mainTexture: imageTarget.color[0] })
85
- );
86
-
87
- renderer.render([screenObject, camera], device);
88
- ```
89
-
90
- This is the core pattern for mirrors, portals, and postprocessing chains.
91
-
92
- ## Step 7: Split Canvas with Viewports
93
-
94
- Use multiple `CanvasTarget` instances on the same canvas.
95
-
96
- ```js
97
- const leftTarget = new CanvasTarget(canvas);
98
- const rightTarget = new CanvasTarget(canvas);
99
-
100
- leftTarget.viewport.offset.set(0, 0);
101
- leftTarget.viewport.size.set(0.5, 1);
102
-
103
- rightTarget.viewport.offset.set(0.5, 0);
104
- rightTarget.viewport.size.set(0.5, 1);
105
- ```
106
-
107
- Viewport values are normalized (0 to 1) relative to full canvas size.
108
-
109
- ## Step 8: Bind Cameras to Each View and Render Once
110
-
111
- ```js
112
- const leftCamera = new Camera(leftTarget);
113
- const rightCamera = new Camera(rightTarget);
114
-
115
- renderer.render([scene, leftCamera, rightCamera], device);
116
- ```
117
-
118
- This gives independent camera views in a single canvas. If a camera should see a different subset of objects, use `renderMask` bits to separate them before the single render call.
119
-
120
- ## Step 9: Use Scissor for Hard Split/Masking
121
-
122
- ```js
123
- leftTarget.scissor = new ViewRectangle();
124
- rightTarget.scissor = new ViewRectangle();
125
-
126
- leftTarget.scissor.offset.set(0, 0);
127
- leftTarget.scissor.size.set(0.5, 1);
128
-
129
- rightTarget.scissor.offset.set(0.5, 0);
130
- rightTarget.scissor.size.set(0.5, 1);
131
- ```
132
-
133
- Scissor restricts actual draw area, useful for editor layouts and split bars.
134
-
135
- ## Resize Rule for Multi-View Scenes
136
-
137
- Keep canvas size and camera projection in sync on resize.
138
- For split views, compute aspect per view region (not full canvas).
139
-
140
- ## Reference Examples
141
-
142
- - [Basic Canvas Target](/examples/rendertarget/basic_canvas)
143
- - [Image Target](/examples/rendertarget/image_target)
144
- - [Split Screen](/examples/rendertarget/split_screen)
145
- - [Multiple Views](/examples/rendertarget/multiple_views)
146
- - [Split View](/examples/rendertarget/split_view)
@@ -1,113 +0,0 @@
1
- ---
2
- title: "Scene Graph and Transforms"
3
- ---
4
-
5
- # Scene Graph and Transforms
6
-
7
- This guide assumes you already have a running scene from [First Scene](/guide/first-scene).
8
- Here, we focus on parent-child relationships and transform behavior.
9
-
10
- ## What You Will Add
11
-
12
- - a parent object
13
- - one or more child objects
14
- - local transforms per node
15
- - frame updates that propagate through hierarchy
16
-
17
- ## Step 1: Import What You Need
18
-
19
- ```js
20
- import { Object3D, MeshMaterial3D, Quaternion } from "chorama";
21
- ```
22
-
23
- Use `Object3D` for grouping and transform hierarchy.
24
- Use `MeshMaterial3D` when the node should be renderable.
25
-
26
- ## Step 2: Create Parent and Child Nodes
27
-
28
- ```js
29
- const root = new Object3D();
30
- const parent = new MeshMaterial3D(mesh, material);
31
- const child = new MeshMaterial3D(mesh, material);
32
- ```
33
-
34
- `root` is a logical container.
35
- `parent` and `child` are visible mesh nodes.
36
-
37
- ## Step 3: Build the Hierarchy
38
-
39
- ```js
40
- root.add(parent);
41
- parent.add(child);
42
- ```
43
-
44
- Now `child` inherits `parent` transform changes.
45
- If parent rotates or moves, child follows automatically.
46
-
47
- ## Step 4: Set Local Transforms
48
-
49
- ```js
50
- parent.transform.position.x = 0;
51
- child.transform.position.x = 1;
52
- ```
53
-
54
- `child.transform.position.x = 1` means "one unit from parent", not world origin.
55
- Think in local space first when building hierarchies.
56
-
57
- ## Step 5: Animate the Parent
58
-
59
- ```js
60
- const stepRotation = Quaternion.fromEuler(0.01, 0.01, 0.0);
61
-
62
- function updateScene() {
63
- parent.transform.orientation.multiply(stepRotation);
64
- }
65
- ```
66
-
67
- Rotating the parent creates orbital motion for the child due to inheritance.
68
- This is the simplest way to verify propagation is working.
69
-
70
- ## Step 6: Render the Hierarchy
71
-
72
- ```js
73
- function frame() {
74
- updateScene();
75
- renderer.render([root, camera], device);
76
- requestAnimationFrame(frame);
77
- }
78
-
79
- requestAnimationFrame(frame);
80
- ```
81
-
82
- You can render the root and let traversal include descendants.
83
- You do not need to pass every child separately if already attached.
84
-
85
- ## Traverse the Graph for Bulk Operations
86
-
87
- ```js
88
- root.traverseDFS((node) => {
89
- // Example: debug flags, tagging, filtering, or custom updates
90
- return true;
91
- });
92
- ```
93
-
94
- Use traversal when you need one operation across many descendants.
95
- Return `true` to continue deeper traversal.
96
-
97
- ## Reparent Safely
98
-
99
- ```js
100
- const newParent = new Object3D();
101
- root.add(newParent);
102
- newParent.add(child);
103
- parent.remove(child);
104
- ```
105
-
106
- Reparenting changes which transform chain affects the object.
107
-
108
- ## Reference Examples
109
-
110
- - [Transform Propagation](/examples/transform/propagation)
111
- - [Skinning](/examples/mesh/skinning)
112
-
113
- After this works, continue with [Render Targets and Views](/guide/render-targets-and-views)
@@ -1,123 +0,0 @@
1
- ---
2
- title: "Textures and Assets"
3
- ---
4
-
5
- This guide assumes your scene already renders from [First Scene](/guide/first-scene).
6
- Here, we focus only on bringing external assets into that scene.
7
-
8
- ## What You Will Add
9
-
10
- - image textures
11
- - OBJ models
12
- - glTF models
13
- - safe runtime handling while assets stream in
14
-
15
- ## Step 1: Import Loaders
16
-
17
- ```js
18
- import { TextureLoader, OBJLoader, GLTFLoader } from "chorama";
19
- ```
20
-
21
- Create one loader instance per asset type and reuse it.
22
-
23
- ## Step 2: Load a Texture
24
-
25
- ```js
26
- const textureLoader = new TextureLoader();
27
-
28
- const texture = textureLoader.load({
29
- paths: ["/images/uv.jpg"],
30
- flipX: false,
31
- flipY: true
32
- });
33
- ```
34
-
35
- Keep paths relative to your app's static/public asset root.
36
- `flipX` mirrors the image horizontally and `flipY` mirrors it vertically before upload.
37
-
38
- ## Step 3: Apply the Texture to a Material
39
-
40
- ```js
41
- const material = new BasicMaterial({
42
- mainTexture: texture
43
- });
44
-
45
- const object = new MeshMaterial3D(mesh, material);
46
- ```
47
-
48
- Once assigned, the texture updates automatically when loading completes.
49
- You can render immediately, no manual onready callback is required for basic flow.
50
-
51
- ## Step 4: Load an OBJ Model
52
-
53
- ```js
54
- const objLoader = new OBJLoader();
55
-
56
- const objRoot = objLoader.load({
57
- paths: ["/models/model.obj"]
58
- });
59
- ```
60
-
61
- `objRoot` is available immediately and fills as data arrives.
62
- You can include it in your render list right away.
63
-
64
- ## Step 5: Optionally Patch Imported OBJ Materials
65
-
66
- If you want to force a change across imported meshes, use `postprocessor`.
67
- An example is to assign a texture to all objects in an obj file
68
-
69
- ```js
70
- const objRoot = objLoader.load({
71
- paths: ["/models/obj/pirate_girl/pirate_girl.obj"],
72
- postprocessor: (asset) => {
73
- asset.traverseDFS((node) => {
74
- if (node instanceof MeshMaterial3D) {
75
- node.material.mainTexture = texture;
76
- }
77
- return true;
78
- });
79
- }
80
- });
81
- ```
82
-
83
- ## Step 6: Load a glTF Scene
84
-
85
- ```js
86
- const gltfLoader = new GLTFLoader();
87
-
88
- const sceneRoot = gltfLoader.load({
89
- paths: ["/models/pirate_girl.gltf"]
90
- });
91
- ```
92
-
93
- Use glTF when you want richer material data and better modern tooling support.
94
-
95
- ## Step 7: Render Streaming Assets Safely
96
-
97
- ```js
98
- function frame() {
99
- renderer.render([object, objRoot, sceneRoot, camera], device);
100
- requestAnimationFrame(frame);
101
- }
102
-
103
- requestAnimationFrame(frame);
104
- ```
105
-
106
- Does not block rendering while waiting for loaders;
107
- Render continuously with placeholders and loaded data will appear as they become ready.
108
-
109
- ## Path Rules That Prevent Most Loading Errors
110
-
111
- 1. Use forward slashes in URLs, even on Windows.
112
- 2. Use absolute app-root paths like `...` when possible.
113
- 3. Keep `.gltf` sidecar files (`.bin`, textures) in expected relative locations.
114
- 4. Confirm your dev server actually serves the asset directory.
115
-
116
- ## Reference Examples
117
-
118
- - [OBJ Loader](/examples/loader/objloader)
119
- - [glTF Loader](/examples/loader/gltfloader)
120
- - [Iridescence Lamp](/examples/loader/gltf/material/iridescence_lamp)
121
- - [Teapot Reflection Refraction](/examples/material/standard/reflection_refraction)
122
-
123
- After this works, continue with [Scene Graph and Transforms](/guide/scene-graph-and-transforms)
@@ -1,49 +0,0 @@
1
- ---
2
- title: "Troubleshooting"
3
- ---
4
-
5
- # Troubleshooting
6
-
7
- ## Blank Canvas
8
-
9
- - Confirm WebGL2 is available in your browser.
10
- - Ensure you created `WebGLRenderDevice` with a valid canvas.
11
- - Ensure `renderer.render([... , camera], device)` includes a camera.
12
-
13
- ```js
14
- const device = new WebGLRenderDevice(canvas, { depth: true });
15
- ```
16
-
17
- ## Object Is Black or Unlit
18
-
19
- - Add `LightPlugin` for lit materials.
20
- - Add at least one light (`AmbientLight`, `DirectionalLight`, etc.).
21
- - Keep `MeshMaterialPlugin` and `CameraPlugin` enabled.
22
-
23
- ## Distorted Aspect Ratio
24
-
25
- Update canvas size and camera projection on resize.
26
-
27
- ```js
28
- if (camera.projection instanceof PerspectiveProjection) {
29
- camera.projection.aspect = innerWidth / innerHeight;
30
- }
31
- ```
32
-
33
- ## Missing Textures or Models
34
-
35
- - Use correct asset URLs under `...`.
36
- - Check browser network tab for 404s.
37
- - For cube maps, provide all six faces in the expected order.
38
-
39
- ## Shadows Not Visible
40
-
41
- - Add `ShadowPlugin`.
42
- - Assign `light.shadow` and tune `bias`/`normalBias`.
43
- - Verify shadow camera bounds include your objects.
44
-
45
- Useful full examples:
46
-
47
- - [Rotating Cube](/examples/other/rotatingCube)
48
- - [Directional Light](/examples/lights/directional)
49
- - [Image Target](/examples/rendertarget/image_target)
@@ -1 +0,0 @@
1
- .markdown-alert{background:var(--surface-2);color:var(--text);border-left:4px solid;border-radius:0;margin:1.25rem 0;padding:1rem 1.2rem;font-size:.95rem;line-height:1.6}.markdown-alert-title{letter-spacing:.05em;text-transform:uppercase;border-radius:0;align-items:center;gap:.5rem;padding:.25rem .6rem;font-size:1.5rem;font-weight:1000;display:inline-flex}.markdown-alert p{margin:.5rem 0 0}.markdown-alert strong{margin-bottom:.25rem;font-weight:600;display:block}.markdown-alert-note{border-left-color:#60a5fa}.markdown-alert-tip{border-left-color:#34d399}.markdown-alert-important{border-left-color:#c084fc}.markdown-alert-warning{border-left-color:#fbbf24}.markdown-alert-caution{border-left-color:#f87171}:root{color-scheme:dark;--bg:#05070a;--panel:#0b1118;--surface-2:#101721;--surface-3:#151d28;--text:#eef2f7;--muted:#a8b1bd;--border:#243043;--border-strong:#314055;--accent:#7dd3fc;--accent-secondary:#cbeafe;--code-bg:#090d13;--code-text:#f3f4f6}*{box-sizing:border-box}body{color:var(--text);background:var(--bg);margin:0;font-family:Segoe UI,Helvetica Neue,Arial,sans-serif}.shell{min-height:100vh}.menu-toggle{border:1px solid var(--border);background:var(--panel);width:2.8rem;height:2.8rem;color:var(--text);z-index:1000;border-radius:0;flex-direction:column;justify-content:center;align-items:center;gap:.32rem;padding:0;display:none;position:fixed;top:.9rem;left:.9rem}.menu-toggle span{background:var(--text);border-radius:0;width:1.25rem;height:2px}aside{background:var(--panel);border:1px solid var(--border);width:260px;height:100vh;box-shadow:none;overflow-anchor:none;z-index:900;border-radius:0;padding:1.25rem 1rem;position:fixed;top:0;left:0;overflow-y:auto}.tabs-title{letter-spacing:.08em;text-transform:uppercase;color:var(--accent-secondary);margin:0 0 .75rem;font-size:.82rem}.tabs{flex-direction:column;gap:0;width:100%;margin:0;padding:0;list-style:none;display:flex}.tab-item{flex-direction:column;gap:0;width:100%;display:flex}.tabs{position:relative}.tabs a,.tab-toggle{border:1px solid var(--border);width:100%;color:var(--text);background:var(--surface-2);border-radius:0;padding:.65rem .8rem;font-size:.92rem;font-weight:600;text-decoration:none;display:block;box-shadow:inset 0 1px #ffffff08}.tab-toggle{appearance:none;cursor:pointer;text-align:left;justify-content:space-between;align-items:center;list-style:none;display:flex}.tab-toggle::-webkit-details-marker{display:none}.tab-toggle .chevron{color:var(--muted)}.tab-group[open]>.tab-toggle .chevron{transform:rotate(90deg)}.tabs a:hover,.tab-toggle:hover{color:var(--accent);border-color:var(--border-strong);background:var(--surface-3)}.tabs a.is-active,.tab-toggle.is-active,.subtabs a.is-active{color:var(--accent);background:#7dd3fc14;border-color:#7dd3fc61}.subtabs{flex-direction:column;gap:0;width:100%;margin:0;padding:0 0 0 .5rem;list-style:none;display:flex}.tabs[hidden],.subtabs[hidden]{display:none}.subtabs a{color:var(--muted);background:var(--surface-3);padding:.56rem .9rem;font-size:.88rem}.subtabs a:hover{color:var(--accent)}main{min-height:100vh;box-shadow:none;background:0 0;border:0;border-radius:0;margin:0 0 0 260px;padding:2rem}h1,h2,h3{line-height:1.25}h1{margin-top:0}h2{border-bottom:1px solid var(--border);color:var(--accent);margin-top:2rem;padding-bottom:.35rem}h3{color:var(--text);margin-top:1.75rem}p,li,blockquote{color:var(--muted);line-height:1.6}ul,ol{padding-left:1.25rem}hr{display:none}blockquote{border:1px solid var(--border);border-left:4px solid var(--accent);background:var(--surface-2);border-radius:0;margin:1.5rem 0;padding:.95rem 1.1rem}table{border-collapse:collapse;border:1px solid var(--border);border-radius:0;width:100%;margin:1.5rem 0;overflow:hidden}th,td{border-bottom:1px solid var(--border);vertical-align:top;padding:.75rem .9rem}th{text-align:left;color:var(--text);background:var(--surface-2)}tr:last-child td{border-bottom:0}code{font-family:Cascadia Code,Fira Code,Consolas,monospace}p code,li code,td code,blockquote code{border:1px solid var(--border);color:var(--text);background:#ffffff08;border-radius:0;padding:.12rem .35rem}pre{background:var(--code-bg);color:var(--code-text);border-radius:0;padding:1rem;overflow-x:auto}pre code{color:inherit}.astro-code{border:1px solid var(--border);border-radius:0;background-color:var(--code-bg)!important}a{color:var(--accent)}a:hover{color:var(--accent-secondary)}@media (width<=900px){.menu-toggle{display:inline-flex}aside{border-radius:0;transition:transform .18s;transform:translate(-100%);box-shadow:0 14px 34px #00000080}body.menu-open aside{transform:translate(0)}body.menu-open .menu-toggle span:first-child{transform:translateY(6px)rotate(45deg)}body.menu-open .menu-toggle span:nth-child(2){opacity:0}body.menu-open .menu-toggle span:nth-child(3){transform:translateY(-6px)rotate(-45deg)}.tabs{flex-direction:column}main{min-height:calc(100vh - 4.8rem);margin:4.8rem 0 0}}