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.
- package/README.md +2 -1
- package/dist/index.module.js +32480 -15098
- package/dist/index.module.js.map +1 -1
- package/dist/index.umd.js +32628 -15121
- package/dist/index.umd.js.map +1 -1
- package/package.json +7 -2
- package/.configs/tsconfig.lib.json +0 -43
- package/.configs/tsconfig.website.json +0 -34
- package/.github/workflows/publish.yml +0 -24
- package/.github/workflows/static.yml +0 -57
- package/.vscode/launch.json +0 -29
- package/.vscode/tasks.json +0 -19
- package/assets/images/disappointed.jpg +0 -0
- package/assets/images/skybox/grimmnight_back.png +0 -0
- package/assets/images/skybox/grimmnight_bottom.png +0 -0
- package/assets/images/skybox/grimmnight_front.png +0 -0
- package/assets/images/skybox/grimmnight_left.png +0 -0
- package/assets/images/skybox/grimmnight_right.png +0 -0
- package/assets/images/skybox/grimmnight_top.png +0 -0
- package/assets/images/skybox/miramar_back.png +0 -0
- package/assets/images/skybox/miramar_bottom.png +0 -0
- package/assets/images/skybox/miramar_front.png +0 -0
- package/assets/images/skybox/miramar_left.png +0 -0
- package/assets/images/skybox/miramar_right.png +0 -0
- package/assets/images/skybox/miramar_top.png +0 -0
- package/assets/images/uv.jpg +0 -0
- package/assets/models/glb/AlphaBlendModeTest.glb +0 -0
- package/assets/models/glb/IridescenceLamp.glb +0 -0
- package/assets/models/glb/teapot.glb +0 -0
- package/assets/models/gltf/flight_helmet/FlightHelmet_Materials_GlassPlasticMat_BaseColor.png +0 -0
- package/assets/models/gltf/flight_helmet/FlightHelmet_Materials_GlassPlasticMat_Normal.png +0 -0
- package/assets/models/gltf/flight_helmet/FlightHelmet_Materials_GlassPlasticMat_OcclusionRoughMetal.png +0 -0
- package/assets/models/gltf/flight_helmet/FlightHelmet_Materials_LeatherPartsMat_BaseColor.png +0 -0
- package/assets/models/gltf/flight_helmet/FlightHelmet_Materials_LeatherPartsMat_Normal.png +0 -0
- package/assets/models/gltf/flight_helmet/FlightHelmet_Materials_LeatherPartsMat_OcclusionRoughMetal.png +0 -0
- package/assets/models/gltf/flight_helmet/FlightHelmet_Materials_LensesMat_BaseColor.png +0 -0
- package/assets/models/gltf/flight_helmet/FlightHelmet_Materials_LensesMat_Normal.png +0 -0
- package/assets/models/gltf/flight_helmet/FlightHelmet_Materials_LensesMat_OcclusionRoughMetal.png +0 -0
- package/assets/models/gltf/flight_helmet/FlightHelmet_Materials_MetalPartsMat_BaseColor.png +0 -0
- package/assets/models/gltf/flight_helmet/FlightHelmet_Materials_MetalPartsMat_Normal.png +0 -0
- package/assets/models/gltf/flight_helmet/FlightHelmet_Materials_MetalPartsMat_OcclusionRoughMetal.png +0 -0
- package/assets/models/gltf/flight_helmet/FlightHelmet_Materials_RubberWoodMat_BaseColor.png +0 -0
- package/assets/models/gltf/flight_helmet/FlightHelmet_Materials_RubberWoodMat_Normal.png +0 -0
- package/assets/models/gltf/flight_helmet/FlightHelmet_Materials_RubberWoodMat_OcclusionRoughMetal.png +0 -0
- package/assets/models/gltf/flight_helmet/index.bin +0 -0
- package/assets/models/gltf/flight_helmet/index.gltf +0 -705
- package/assets/models/gltf/object.gltf +0 -23
- package/assets/models/gltf/pirate_girl/index.bin +0 -0
- package/assets/models/gltf/pirate_girl/index.gltf +0 -2082
- package/assets/models/obj/pirate_girl/pirate_girl.obj +0 -18459
- package/assets/models/obj/pirate_girl/pirate_girl.png +0 -0
- package/astro.config.mjs +0 -33
- package/content/guide/api-map.md +0 -89
- package/content/guide/camera-and-controls.md +0 -98
- package/content/guide/first-scene.md +0 -176
- package/content/guide/index.md +0 -72
- package/content/guide/installation.md +0 -179
- package/content/guide/materials-and-lighting.md +0 -138
- package/content/guide/plugins-and-render-pipeline.md +0 -124
- package/content/guide/render-targets-and-views.md +0 -146
- package/content/guide/scene-graph-and-transforms.md +0 -113
- package/content/guide/textures-and-assets.md +0 -123
- package/content/guide/troubleshooting.md +0 -49
- package/dist/website/_astro/DocLayout.BsV7p0dY.css +0 -1
- package/dist/website/examples/camera/orthographic/example.html +0 -172
- package/dist/website/examples/camera/orthographic/index.html +0 -124
- package/dist/website/examples/camera/perspective/example.html +0 -190
- package/dist/website/examples/camera/perspective/index.html +0 -142
- package/dist/website/examples/camera/tone_mapping/example.html +0 -238
- package/dist/website/examples/camera/tone_mapping/index.html +0 -190
- package/dist/website/examples/index.html +0 -2
- package/dist/website/examples/lights/directional/example.html +0 -447
- package/dist/website/examples/lights/directional/index.html +0 -399
- package/dist/website/examples/lights/multiple_spot_lights/example.html +0 -356
- package/dist/website/examples/lights/multiple_spot_lights/index.html +0 -308
- package/dist/website/examples/lights/point/example.html +0 -387
- package/dist/website/examples/lights/point/index.html +0 -339
- package/dist/website/examples/lights/spot/example.html +0 -416
- package/dist/website/examples/lights/spot/index.html +0 -368
- package/dist/website/examples/loader/gltf/basic/example.html +0 -129
- package/dist/website/examples/loader/gltf/basic/index.html +0 -81
- package/dist/website/examples/loader/gltf/material/alpha-blend-mode/example.html +0 -131
- package/dist/website/examples/loader/gltf/material/alpha-blend-mode/index.html +0 -83
- package/dist/website/examples/loader/gltf/material/flight_helmet/example.html +0 -162
- package/dist/website/examples/loader/gltf/material/flight_helmet/index.html +0 -114
- package/dist/website/examples/loader/gltf/material/iridescence_lamp/example.html +0 -169
- package/dist/website/examples/loader/gltf/material/iridescence_lamp/index.html +0 -121
- package/dist/website/examples/loader/objloader/example.html +0 -144
- package/dist/website/examples/loader/objloader/index.html +0 -96
- package/dist/website/examples/material/cullface/example.html +0 -163
- package/dist/website/examples/material/cullface/index.html +0 -115
- package/dist/website/examples/material/materials/example.html +0 -175
- package/dist/website/examples/material/materials/index.html +0 -127
- package/dist/website/examples/material/standard/basic/example.html +0 -212
- package/dist/website/examples/material/standard/basic/index.html +0 -164
- package/dist/website/examples/material/standard/reflection_refraction/example.html +0 -241
- package/dist/website/examples/material/standard/reflection_refraction/index.html +0 -193
- package/dist/website/examples/mesh/capsule/example.html +0 -173
- package/dist/website/examples/mesh/capsule/index.html +0 -125
- package/dist/website/examples/mesh/circle/example.html +0 -173
- package/dist/website/examples/mesh/circle/index.html +0 -125
- package/dist/website/examples/mesh/cone/example.html +0 -180
- package/dist/website/examples/mesh/cone/index.html +0 -132
- package/dist/website/examples/mesh/cuboid/example.html +0 -207
- package/dist/website/examples/mesh/cuboid/index.html +0 -159
- package/dist/website/examples/mesh/cylinder/example.html +0 -195
- package/dist/website/examples/mesh/cylinder/index.html +0 -147
- package/dist/website/examples/mesh/dodecahedron/example.html +0 -158
- package/dist/website/examples/mesh/dodecahedron/index.html +0 -110
- package/dist/website/examples/mesh/ellipsoid/example.html +0 -179
- package/dist/website/examples/mesh/ellipsoid/index.html +0 -131
- package/dist/website/examples/mesh/extrude/example.html +0 -169
- package/dist/website/examples/mesh/extrude/index.html +0 -121
- package/dist/website/examples/mesh/frustum/example.html +0 -185
- package/dist/website/examples/mesh/frustum/index.html +0 -137
- package/dist/website/examples/mesh/helix/example.html +0 -184
- package/dist/website/examples/mesh/helix/index.html +0 -136
- package/dist/website/examples/mesh/icosahedron/example.html +0 -158
- package/dist/website/examples/mesh/icosahedron/index.html +0 -110
- package/dist/website/examples/mesh/icosphere/example.html +0 -163
- package/dist/website/examples/mesh/icosphere/index.html +0 -115
- package/dist/website/examples/mesh/lathe/example.html +0 -175
- package/dist/website/examples/mesh/lathe/index.html +0 -127
- package/dist/website/examples/mesh/meshTopology/example.html +0 -210
- package/dist/website/examples/mesh/meshTopology/index.html +0 -162
- package/dist/website/examples/mesh/octahedron/example.html +0 -158
- package/dist/website/examples/mesh/octahedron/index.html +0 -110
- package/dist/website/examples/mesh/plane/example.html +0 -173
- package/dist/website/examples/mesh/plane/index.html +0 -125
- package/dist/website/examples/mesh/prism/example.html +0 -173
- package/dist/website/examples/mesh/prism/index.html +0 -125
- package/dist/website/examples/mesh/pyramid/example.html +0 -172
- package/dist/website/examples/mesh/pyramid/index.html +0 -124
- package/dist/website/examples/mesh/ring/example.html +0 -173
- package/dist/website/examples/mesh/ring/index.html +0 -125
- package/dist/website/examples/mesh/skinning/example.html +0 -187
- package/dist/website/examples/mesh/skinning/index.html +0 -139
- package/dist/website/examples/mesh/terrain/example.html +0 -214
- package/dist/website/examples/mesh/terrain/index.html +0 -166
- package/dist/website/examples/mesh/tetrahedron/example.html +0 -158
- package/dist/website/examples/mesh/tetrahedron/index.html +0 -110
- package/dist/website/examples/mesh/torus/example.html +0 -173
- package/dist/website/examples/mesh/torus/index.html +0 -125
- package/dist/website/examples/mesh/torus-knot/example.html +0 -188
- package/dist/website/examples/mesh/torus-knot/index.html +0 -140
- package/dist/website/examples/mesh/tube/example.html +0 -180
- package/dist/website/examples/mesh/tube/index.html +0 -132
- package/dist/website/examples/mesh/uvsphere/example.html +0 -169
- package/dist/website/examples/mesh/uvsphere/index.html +0 -121
- package/dist/website/examples/mesh/wedge/example.html +0 -168
- package/dist/website/examples/mesh/wedge/index.html +0 -120
- package/dist/website/examples/other/rotatingCube/example.html +0 -142
- package/dist/website/examples/other/rotatingCube/index.html +0 -94
- package/dist/website/examples/other/rotatingSphere/example.html +0 -144
- package/dist/website/examples/other/rotatingSphere/index.html +0 -96
- package/dist/website/examples/rendertarget/basic_canvas/example.html +0 -178
- package/dist/website/examples/rendertarget/basic_canvas/index.html +0 -130
- package/dist/website/examples/rendertarget/depth_texture/example.html +0 -188
- package/dist/website/examples/rendertarget/depth_texture/index.html +0 -140
- package/dist/website/examples/rendertarget/image_target/example.html +0 -196
- package/dist/website/examples/rendertarget/image_target/index.html +0 -148
- package/dist/website/examples/rendertarget/multiple_views/example.html +0 -204
- package/dist/website/examples/rendertarget/multiple_views/index.html +0 -156
- package/dist/website/examples/rendertarget/render_masks/example.html +0 -222
- package/dist/website/examples/rendertarget/render_masks/index.html +0 -174
- package/dist/website/examples/rendertarget/split_screen/example.html +0 -178
- package/dist/website/examples/rendertarget/split_screen/index.html +0 -130
- package/dist/website/examples/rendertarget/split_view/example.html +0 -191
- package/dist/website/examples/rendertarget/split_view/index.html +0 -143
- package/dist/website/examples/skybox/skybox/example.html +0 -162
- package/dist/website/examples/skybox/skybox/index.html +0 -114
- package/dist/website/examples/texture/arrays/example.html +0 -204
- package/dist/website/examples/texture/arrays/index.html +0 -156
- package/dist/website/examples/texture/textureWrap/example.html +0 -169
- package/dist/website/examples/texture/textureWrap/index.html +0 -121
- package/dist/website/examples/transform/propagation/example.html +0 -141
- package/dist/website/examples/transform/propagation/index.html +0 -93
- package/dist/website/guide/api-map/index.html +0 -82
- package/dist/website/guide/camera-and-controls/index.html +0 -62
- package/dist/website/guide/first-scene/index.html +0 -119
- package/dist/website/guide/index.html +0 -58
- package/dist/website/guide/installation/index.html +0 -133
- package/dist/website/guide/materials-and-lighting/index.html +0 -90
- package/dist/website/guide/plugins-and-render-pipeline/index.html +0 -89
- package/dist/website/guide/render-targets-and-views/index.html +0 -95
- package/dist/website/guide/scene-graph-and-transforms/index.html +0 -69
- package/dist/website/guide/textures-and-assets/index.html +0 -85
- package/dist/website/guide/troubleshooting/index.html +0 -39
- package/dist/website/images/disappointed.jpg +0 -0
- package/dist/website/images/skybox/grimmnight_back.png +0 -0
- package/dist/website/images/skybox/grimmnight_bottom.png +0 -0
- package/dist/website/images/skybox/grimmnight_front.png +0 -0
- package/dist/website/images/skybox/grimmnight_left.png +0 -0
- package/dist/website/images/skybox/grimmnight_right.png +0 -0
- package/dist/website/images/skybox/grimmnight_top.png +0 -0
- package/dist/website/images/skybox/miramar_back.png +0 -0
- package/dist/website/images/skybox/miramar_bottom.png +0 -0
- package/dist/website/images/skybox/miramar_front.png +0 -0
- package/dist/website/images/skybox/miramar_left.png +0 -0
- package/dist/website/images/skybox/miramar_right.png +0 -0
- package/dist/website/images/skybox/miramar_top.png +0 -0
- package/dist/website/images/uv.jpg +0 -0
- package/dist/website/index.html +0 -157
- package/dist/website/models/glb/AlphaBlendModeTest.glb +0 -0
- package/dist/website/models/glb/IridescenceLamp.glb +0 -0
- package/dist/website/models/glb/teapot.glb +0 -0
- package/dist/website/models/gltf/flight_helmet/FlightHelmet_Materials_GlassPlasticMat_BaseColor.png +0 -0
- package/dist/website/models/gltf/flight_helmet/FlightHelmet_Materials_GlassPlasticMat_Normal.png +0 -0
- package/dist/website/models/gltf/flight_helmet/FlightHelmet_Materials_GlassPlasticMat_OcclusionRoughMetal.png +0 -0
- package/dist/website/models/gltf/flight_helmet/FlightHelmet_Materials_LeatherPartsMat_BaseColor.png +0 -0
- package/dist/website/models/gltf/flight_helmet/FlightHelmet_Materials_LeatherPartsMat_Normal.png +0 -0
- package/dist/website/models/gltf/flight_helmet/FlightHelmet_Materials_LeatherPartsMat_OcclusionRoughMetal.png +0 -0
- package/dist/website/models/gltf/flight_helmet/FlightHelmet_Materials_LensesMat_BaseColor.png +0 -0
- package/dist/website/models/gltf/flight_helmet/FlightHelmet_Materials_LensesMat_Normal.png +0 -0
- package/dist/website/models/gltf/flight_helmet/FlightHelmet_Materials_LensesMat_OcclusionRoughMetal.png +0 -0
- package/dist/website/models/gltf/flight_helmet/FlightHelmet_Materials_MetalPartsMat_BaseColor.png +0 -0
- package/dist/website/models/gltf/flight_helmet/FlightHelmet_Materials_MetalPartsMat_Normal.png +0 -0
- package/dist/website/models/gltf/flight_helmet/FlightHelmet_Materials_MetalPartsMat_OcclusionRoughMetal.png +0 -0
- package/dist/website/models/gltf/flight_helmet/FlightHelmet_Materials_RubberWoodMat_BaseColor.png +0 -0
- package/dist/website/models/gltf/flight_helmet/FlightHelmet_Materials_RubberWoodMat_Normal.png +0 -0
- package/dist/website/models/gltf/flight_helmet/FlightHelmet_Materials_RubberWoodMat_OcclusionRoughMetal.png +0 -0
- package/dist/website/models/gltf/flight_helmet/index.bin +0 -0
- package/dist/website/models/gltf/flight_helmet/index.gltf +0 -705
- package/dist/website/models/gltf/object.gltf +0 -23
- package/dist/website/models/gltf/pirate_girl/index.bin +0 -0
- package/dist/website/models/gltf/pirate_girl/index.gltf +0 -2082
- package/dist/website/models/obj/pirate_girl/pirate_girl.obj +0 -18459
- package/dist/website/models/obj/pirate_girl/pirate_girl.png +0 -0
- package/env.d.ts +0 -5
- package/examples/camera/orthographic.js +0 -121
- package/examples/camera/perspective.js +0 -139
- package/examples/camera/tone_mapping.js +0 -187
- package/examples/lights/directional.js +0 -396
- package/examples/lights/multiple_spot_lights.js +0 -305
- package/examples/lights/point.js +0 -336
- package/examples/lights/spot.js +0 -365
- package/examples/loader/gltf/basic.js +0 -78
- package/examples/loader/gltf/material/alpha-blend-mode.js +0 -80
- package/examples/loader/gltf/material/flight_helmet.js +0 -111
- package/examples/loader/gltf/material/iridescence_lamp.js +0 -118
- package/examples/loader/objloader.js +0 -93
- package/examples/material/cullface.js +0 -112
- package/examples/material/materials.js +0 -124
- package/examples/material/standard/basic.js +0 -161
- package/examples/material/standard/reflection_refraction.js +0 -190
- package/examples/mesh/capsule.js +0 -122
- package/examples/mesh/circle.js +0 -122
- package/examples/mesh/cone.js +0 -129
- package/examples/mesh/cuboid.js +0 -156
- package/examples/mesh/cylinder.js +0 -144
- package/examples/mesh/dodecahedron.js +0 -107
- package/examples/mesh/ellipsoid.js +0 -128
- package/examples/mesh/extrude.js +0 -118
- package/examples/mesh/frustum.js +0 -134
- package/examples/mesh/helix.js +0 -133
- package/examples/mesh/icosahedron.js +0 -107
- package/examples/mesh/icosphere.js +0 -112
- package/examples/mesh/lathe.js +0 -124
- package/examples/mesh/meshTopology.js +0 -159
- package/examples/mesh/octahedron.js +0 -107
- package/examples/mesh/plane.js +0 -122
- package/examples/mesh/prism.js +0 -122
- package/examples/mesh/pyramid.js +0 -121
- package/examples/mesh/ring.js +0 -122
- package/examples/mesh/skinning.js +0 -136
- package/examples/mesh/terrain.js +0 -163
- package/examples/mesh/tetrahedron.js +0 -107
- package/examples/mesh/torus-knot.js +0 -137
- package/examples/mesh/torus.js +0 -122
- package/examples/mesh/tube.js +0 -129
- package/examples/mesh/uvsphere.js +0 -118
- package/examples/mesh/wedge.js +0 -117
- package/examples/other/rotatingCube.js +0 -91
- package/examples/other/rotatingSphere.js +0 -93
- package/examples/rendertarget/basic_canvas.js +0 -127
- package/examples/rendertarget/depth_texture.js +0 -137
- package/examples/rendertarget/image_target.js +0 -145
- package/examples/rendertarget/multiple_views.js +0 -153
- package/examples/rendertarget/render_masks.js +0 -171
- package/examples/rendertarget/split_screen.js +0 -127
- package/examples/rendertarget/split_view.js +0 -140
- package/examples/skybox/skybox.js +0 -111
- package/examples/texture/arrays.js +0 -153
- package/examples/texture/textureWrap.js +0 -118
- package/examples/transform/propagation.js +0 -90
- package/rollup.config.js +0 -66
- package/src/caches/cache.js +0 -359
- package/src/caches/index.js +0 -2
- package/src/caches/uniformbuffers.js +0 -93
- package/src/cameracontrols/index.js +0 -258
- package/src/constants/index.js +0 -3
- package/src/constants/mesh.js +0 -197
- package/src/constants/others.js +0 -218
- package/src/constants/texture.js +0 -183
- package/src/content.config.js +0 -1
- package/src/core/constants.js +0 -14
- package/src/core/extensions.js +0 -42
- package/src/core/index.js +0 -7
- package/src/core/layouts/bindgroup.js +0 -167
- package/src/core/layouts/index.js +0 -6
- package/src/core/layouts/meshvertex.js +0 -60
- package/src/core/layouts/pipeline.js +0 -165
- package/src/core/layouts/uniform.js +0 -21
- package/src/core/layouts/uniformbuffer.js +0 -23
- package/src/core/layouts/vertexbuffer.js +0 -43
- package/src/core/limits.js +0 -247
- package/src/core/resources/blendparams.js +0 -89
- package/src/core/resources/gpubuffer.js +0 -53
- package/src/core/resources/gpumesh.js +0 -76
- package/src/core/resources/gpusampler.js +0 -43
- package/src/core/resources/gputexture.js +0 -102
- package/src/core/resources/index.js +0 -7
- package/src/core/resources/newuniformbuffer.js +0 -58
- package/src/core/resources/webglshadermodule.js +0 -58
- package/src/core/shader.js +0 -75
- package/src/core/webgl/bindgroup.js +0 -247
- package/src/core/webgl/descriptors.js +0 -166
- package/src/core/webgl/gpuqueue.js +0 -63
- package/src/core/webgl/index.js +0 -8
- package/src/core/webgl/renderpassencoder.js +0 -783
- package/src/core/webgl/renderpipeline.js +0 -91
- package/src/core/webgl/utils.js +0 -521
- package/src/core/webgl/webglrenderdevice.js +0 -259
- package/src/function.js +0 -358
- package/src/index.js +0 -15
- package/src/loader/gltf.js +0 -2722
- package/src/loader/index.js +0 -3
- package/src/loader/loader.js +0 -174
- package/src/loader/obj.js +0 -188
- package/src/loader/texture.js +0 -138
- package/src/loader/utils.js +0 -60
- package/src/material/alphablend.js +0 -21
- package/src/material/basic.js +0 -89
- package/src/material/depth.js +0 -87
- package/src/material/index.js +0 -9
- package/src/material/lambert.js +0 -87
- package/src/material/material.js +0 -148
- package/src/material/normal.js +0 -44
- package/src/material/phong.js +0 -100
- package/src/material/raw.js +0 -71
- package/src/material/standard.js +0 -309
- package/src/math/index.js +0 -3
- package/src/math/transform.js +0 -38
- package/src/mesh/attribute/attribute.js +0 -79
- package/src/mesh/attribute/index.js +0 -1
- package/src/mesh/attributedata/index.js +0 -1
- package/src/mesh/attributedata/separate.js +0 -180
- package/src/mesh/builders/base.js +0 -41
- package/src/mesh/builders/capsule.js +0 -47
- package/src/mesh/builders/circle.js +0 -63
- package/src/mesh/builders/cone.js +0 -29
- package/src/mesh/builders/cuboid.js +0 -135
- package/src/mesh/builders/cylinder.js +0 -131
- package/src/mesh/builders/dodecahedron.js +0 -130
- package/src/mesh/builders/ellipsoid.js +0 -65
- package/src/mesh/builders/extrude.js +0 -136
- package/src/mesh/builders/frustum.js +0 -26
- package/src/mesh/builders/geometry.js +0 -121
- package/src/mesh/builders/helix.js +0 -35
- package/src/mesh/builders/icosahedron.js +0 -61
- package/src/mesh/builders/icosphere.js +0 -141
- package/src/mesh/builders/index.js +0 -28
- package/src/mesh/builders/lathe.js +0 -85
- package/src/mesh/builders/octahedron.js +0 -43
- package/src/mesh/builders/plane.js +0 -73
- package/src/mesh/builders/polyhedron.js +0 -121
- package/src/mesh/builders/prism.js +0 -19
- package/src/mesh/builders/pyramid.js +0 -90
- package/src/mesh/builders/ring.js +0 -109
- package/src/mesh/builders/surfaces.js +0 -69
- package/src/mesh/builders/terrain.js +0 -80
- package/src/mesh/builders/tetrahedron.js +0 -37
- package/src/mesh/builders/torusknot.js +0 -36
- package/src/mesh/builders/tube.js +0 -209
- package/src/mesh/builders/utils.js +0 -148
- package/src/mesh/builders/uvsphere.js +0 -80
- package/src/mesh/builders/wedge.js +0 -22
- package/src/mesh/builders/wireframe.js +0 -62
- package/src/mesh/index.js +0 -4
- package/src/mesh/mesh.js +0 -157
- package/src/objects/bone.js +0 -17
- package/src/objects/camera/camera.js +0 -159
- package/src/objects/camera/index.js +0 -2
- package/src/objects/camera/projection.js +0 -203
- package/src/objects/debug/index.js +0 -1
- package/src/objects/debug/skeleton.js +0 -28
- package/src/objects/index.js +0 -7
- package/src/objects/light/ambient.js +0 -41
- package/src/objects/light/directional.js +0 -51
- package/src/objects/light/index.js +0 -5
- package/src/objects/light/point.js +0 -56
- package/src/objects/light/shadow/index.js +0 -1
- package/src/objects/light/shadow/shadow.js +0 -67
- package/src/objects/light/spot.js +0 -82
- package/src/objects/mesh.js +0 -89
- package/src/objects/object3d.js +0 -167
- package/src/objects/skybox.js +0 -38
- package/src/plugins/camera/RenderTarget2DPool.js +0 -94
- package/src/plugins/camera/camera.js +0 -27
- package/src/plugins/camera/index.js +0 -4
- package/src/plugins/camera/nodes/canvasblit.js +0 -153
- package/src/plugins/camera/nodes/index.js +0 -5
- package/src/plugins/camera/nodes/opaquepass.js +0 -94
- package/src/plugins/camera/nodes/tonemapping.js +0 -217
- package/src/plugins/camera/nodes/transparentpass.js +0 -87
- package/src/plugins/camera/nodes/view.js +0 -72
- package/src/plugins/camera/resources/cameracolortargets.js +0 -66
- package/src/plugins/camera/resources/canvasblitpipeline.js +0 -6
- package/src/plugins/camera/resources/index.js +0 -3
- package/src/plugins/camera/resources/tonemappingpipeline.js +0 -6
- package/src/plugins/index.js +0 -6
- package/src/plugins/light/index.js +0 -2
- package/src/plugins/light/light.js +0 -19
- package/src/plugins/light/nodes/index.js +0 -1
- package/src/plugins/light/nodes/light.js +0 -127
- package/src/plugins/meshmaterial/index.js +0 -3
- package/src/plugins/meshmaterial/meshmaterial.js +0 -644
- package/src/plugins/meshmaterial/nodes/index.js +0 -1
- package/src/plugins/meshmaterial/nodes/meshmaterial.js +0 -83
- package/src/plugins/meshmaterial/resources/bonetexture.js +0 -176
- package/src/plugins/meshmaterial/resources/environmentmap.js +0 -44
- package/src/plugins/meshmaterial/resources/index.js +0 -5
- package/src/plugins/meshmaterial/resources/materialuniformbuffers.js +0 -94
- package/src/plugins/meshmaterial/resources/meshmaterialbindgroups.js +0 -40
- package/src/plugins/meshmaterial/resources/meshmaterialpipelines.js +0 -50
- package/src/plugins/shadow/index.js +0 -3
- package/src/plugins/shadow/nodes/index.js +0 -3
- package/src/plugins/shadow/nodes/occluder.js +0 -106
- package/src/plugins/shadow/nodes/opaquePass.js +0 -110
- package/src/plugins/shadow/nodes/view.js +0 -272
- package/src/plugins/shadow/resources/ShadowMap.js +0 -99
- package/src/plugins/shadow/resources/index.js +0 -2
- package/src/plugins/shadow/resources/shadowpipelines.js +0 -25
- package/src/plugins/shadow/shadow.js +0 -26
- package/src/plugins/skeletonhelper/index.js +0 -1
- package/src/plugins/skeletonhelper/skeletonhelper.js +0 -202
- package/src/plugins/skybox/index.js +0 -3
- package/src/plugins/skybox/nodes/index.js +0 -1
- package/src/plugins/skybox/nodes/skybox.js +0 -335
- package/src/plugins/skybox/resources/index.js +0 -2
- package/src/plugins/skybox/resources/skyboxmesh.js +0 -14
- package/src/plugins/skybox/resources/skyboxpipeline.js +0 -16
- package/src/plugins/skybox/skybox.js +0 -18
- package/src/renderer/core/index.js +0 -293
- package/src/renderer/graph/index.js +0 -3
- package/src/renderer/graph/nodes.js +0 -34
- package/src/renderer/graph/rendergraph.js +0 -182
- package/src/renderer/index.js +0 -5
- package/src/renderer/plugin.js +0 -16
- package/src/renderer/renderer.js +0 -195
- package/src/renderer/views.js +0 -28
- package/src/rendertarget/canvastarget.js +0 -33
- package/src/rendertarget/image.js +0 -132
- package/src/rendertarget/index.js +0 -3
- package/src/rendertarget/rendertarget.js +0 -89
- package/src/shader/basicFragment.glsl +0 -38
- package/src/shader/basicVertex.glsl +0 -98
- package/src/shader/blitFragment.glsl +0 -9
- package/src/shader/common/color.glsl +0 -7
- package/src/shader/common/common.glsl +0 -54
- package/src/shader/common/index.js +0 -5
- package/src/shader/common/light.glsl +0 -437
- package/src/shader/common/math.glsl +0 -12
- package/src/shader/common/tonemap.glsl +0 -118
- package/src/shader/debug/index.js +0 -2
- package/src/shader/debug/skeletonFragment.glsl +0 -6
- package/src/shader/debug/skeletonVertex.glsl +0 -25
- package/src/shader/depthFragment.glsl +0 -34
- package/src/shader/fullscreenVertex.glsl +0 -26
- package/src/shader/index.js +0 -14
- package/src/shader/lambertFragment.glsl +0 -134
- package/src/shader/normalFragment.glsl +0 -22
- package/src/shader/phongFragment.glsl +0 -148
- package/src/shader/skyboxFragment.glsl +0 -16
- package/src/shader/skyboxVertex.glsl +0 -21
- package/src/shader/standardFragment.glsl +0 -331
- package/src/shader/tonemappingFragment.glsl +0 -37
- package/src/texture/index.js +0 -2
- package/src/texture/sampler.js +0 -191
- package/src/texture/texture.js +0 -438
- package/src/utils/index.js +0 -129
- package/src/utils/rendergraph_gui.js +0 -583
- package/tsconfig.json +0 -11
|
@@ -1,89 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html> <html lang="en"> <head><meta charset="UTF-8"><meta name="viewport" content="width=device-width"><meta name="generator" content="Astro v7.2.2"><title>Plugins and Render Pipeline | chorama</title><style>.category-section[data-astro-cid-mzi2nk5r]+.category-section[data-astro-cid-mzi2nk5r]{margin-top:2rem}.category-section[data-astro-cid-mzi2nk5r] h2[data-astro-cid-mzi2nk5r]{margin-bottom:.75rem}.examples-grid[data-astro-cid-mzi2nk5r]{grid-template-columns:repeat(auto-fill,minmax(220px,1fr));gap:1rem;margin-top:1.5rem;display:grid}.example-card[data-astro-cid-mzi2nk5r]{aspect-ratio:4/3;border:1px solid var(--border);background:var(--surface-2);border-radius:0;text-decoration:none;display:block;position:relative;overflow:hidden}.example-card[data-astro-cid-mzi2nk5r] img[data-astro-cid-mzi2nk5r]{object-fit:cover;width:100%;height:100%;display:block}.example-card[data-astro-cid-mzi2nk5r] span[data-astro-cid-mzi2nk5r]{text-align:center;color:#fff;background:linear-gradient(#00000026,#000c);padding:.55rem .75rem;font-weight:700;position:absolute;bottom:0;left:0;right:0}.example-frame[data-astro-cid-mxkslj3q]{width:100%;margin-bottom:1.25rem;position:relative}.example-link[data-astro-cid-mxkslj3q]{z-index:1;color:var(--accent);background:#00000059;border-radius:0;padding:.2rem .5rem;font-weight:600;text-decoration:underline;position:absolute;top:7rem;left:50%;transform:translate(-50%)}.example-link[data-astro-cid-mxkslj3q]:hover{color:var(--accent-secondary)}.source-code[data-astro-cid-mxkslj3q]{outline:1px solid var(--border);outline-offset:0;border-radius:0;overflow:hidden}.example-preview[data-astro-cid-mxkslj3q]{border:1px solid var(--border);background:#fff;border-radius:0;width:100%;height:560px;margin:0 0 1.25rem;display:block}.source-code[data-astro-cid-mxkslj3q] .astro-code{border:0!important;border-radius:0!important}.source-code[data-astro-cid-mxkslj3q] pre{padding:10px;margin:0!important}
|
|
2
|
-
</style><link rel="stylesheet" href="/_astro/DocLayout.BsV7p0dY.css"></head> <body> <div class="shell"> <button class="menu-toggle" id="menu-toggle" type="button" aria-label="Toggle menu" aria-expanded="false" aria-controls="site-sidebar"> <span></span> <span></span> <span></span> </button> <aside id="site-sidebar" aria-label="Sidebar navigation"> <p class="tabs-title">Navigation</p> <div><ul class="tabs"><li class="tab-item"><details class="tab-group"><summary class="tab-toggle"><span>Introduction</span><span class="chevron">›</span></summary><ul class="tabs"><li class="tab-item"><a href="/#features">Features</a></li><li class="tab-item"><a href="/#who-this-is-for">Who This Is For</a></li><li class="tab-item"><a href="/#getting-started">Getting Started</a><ul class="subtabs" hidden><li class="tab-item"><a href="/#requirements">Requirements</a></li><li class="tab-item"><a href="/#install-dependencies">Install dependencies</a></li><li class="tab-item"><a href="/#build-library-bundles">Build library bundles</a></li><li class="tab-item"><a href="/#run-demos">Run demos</a></li></ul></li><li class="tab-item"><a href="/#core-usage-flow">Core Usage Flow</a></li></ul></details></li><li class="tab-item"><details class="tab-group" open><summary class="tab-toggle is-active"><span>Guide</span><span class="chevron">›</span></summary><ul class="tabs"><li class="tab-item"><a href="/guide">Overview</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide#who-this-guide-is-for">Who This Guide Is For</a></li><li class="tab-item"><a href="/guide#how-to-use-this-guide">How To Use This Guide</a></li><li class="tab-item"><a href="/guide#reading-order">Reading Order</a></li><li class="tab-item"><a href="/guide#core-flow">Core Flow</a></li></ul></li><li class="tab-item"><a href="/guide/installation">Installation</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/installation#npm">NPM</a></li><li class="tab-item"><a href="/guide/installation#cdn">CDN</a></li><li class="tab-item"><a href="/guide/installation#manual-installation">Manual Installation</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/installation#1-requirements">Requirements</a></li><li class="tab-item"><a href="/guide/installation#2-clone-the-repository-and-install-dependencies">Clone the repository and install dependencies</a></li><li class="tab-item"><a href="/guide/installation#3-build-the-library-files">Build the library files</a></li><li class="tab-item"><a href="/guide/installation#4-copy-files-to-your-project">Copy files to your project</a></li><li class="tab-item"><a href="/guide/installation#5-use-in-your-project">Use in your project</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/installation#esm-recommended">ESM (recommended)</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/installation#vite-viteconfigjs">Vite (vite.config.js)</a></li><li class="tab-item"><a href="/guide/installation#webpack-webpackconfigjs">Webpack (webpack.config.js)</a></li></ul></li><li class="tab-item"><a href="/guide/installation#plain-html-with-browser-import-maps-no-bundler">Plain HTML with browser import maps (no bundler)</a></li><li class="tab-item"><a href="/guide/installation#plain-html-with-script-tag-umd">Plain HTML with script tag (UMD)</a></li></ul></li></ul></li></ul></li><li class="tab-item"><a href="/guide/first-scene">First Scene</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/first-scene#what-you-will-build">What You Will Build</a></li><li class="tab-item"><a href="/guide/first-scene#before-you-start">Before You Start</a></li><li class="tab-item"><a href="/guide/first-scene#build-your-first-scene">Build Your first scene</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/first-scene#step-1-import-what-you-need">Step 1: Import what you need</a></li><li class="tab-item"><a href="/guide/first-scene#step-2-create-and-mount-a-canvas">Step 2: Create and mount a canvas</a></li><li class="tab-item"><a href="/guide/first-scene#step-3-create-device-and-render-target">Step 3: Create device and render target</a></li><li class="tab-item"><a href="/guide/first-scene#step-4-create-renderer-and-required-plugins">Step 4: Create renderer and required plugins</a></li><li class="tab-item"><a href="/guide/first-scene#step-5-create-and-position-a-camera">Step 5: Create and position a camera</a></li><li class="tab-item"><a href="/guide/first-scene#step-6-create-a-cube-object">Step 6: Create a cube object</a></li><li class="tab-item"><a href="/guide/first-scene#step-7-define-per-frame-rotation">Step 7: Define per-frame rotation</a></li><li class="tab-item"><a href="/guide/first-scene#step-8-add-resize-handling">Step 8: Add resize handling</a></li><li class="tab-item"><a href="/guide/first-scene#step-9-start-the-render-loop">Step 9: Start the render loop</a></li></ul></li><li class="tab-item"><a href="/guide/first-scene#what-you-can-try-next">What You Can Try Next</a></li><li class="tab-item"><a href="/guide/first-scene#reference-example">Reference Example</a></li></ul></li><li class="tab-item"><a href="/guide/camera-and-controls">Camera and Controls</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/camera-and-controls#what-you-will-add">What You Will Add</a></li><li class="tab-item"><a href="/guide/camera-and-controls#step-1-import-camera-apis">Step 1: Import Camera APIs</a></li><li class="tab-item"><a href="/guide/camera-and-controls#step-2-create-a-camera">Step 2: Create a Camera</a></li><li class="tab-item"><a href="/guide/camera-and-controls#step-3-configure-perspective-projection">Step 3: Configure Perspective Projection</a></li><li class="tab-item"><a href="/guide/camera-and-controls#step-4-add-orbit-controls">Step 4: Add Orbit Controls</a></li><li class="tab-item"><a href="/guide/camera-and-controls#step-5-update-controls-in-the-frame-loop">Step 5: Update Controls in the Frame Loop</a></li><li class="tab-item"><a href="/guide/camera-and-controls#switch-to-orthographic-projection">Switch to Orthographic Projection</a></li><li class="tab-item"><a href="/guide/camera-and-controls#reference-examples">Reference Examples</a></li></ul></li><li class="tab-item"><a href="/guide/materials-and-lighting">Materials and Lighting</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/materials-and-lighting#what-you-will-add">What You Will Add</a></li><li class="tab-item"><a href="/guide/materials-and-lighting#step-1-import-material-and-light-apis">Step 1: Import Material and Light APIs</a></li><li class="tab-item"><a href="/guide/materials-and-lighting#step-2-pick-a-material-model">Step 2: Pick a Material Model</a></li><li class="tab-item"><a href="/guide/materials-and-lighting#step-3-apply-the-material-to-your-mesh-object">Step 3: Apply the Material to Your Mesh Object</a></li><li class="tab-item"><a href="/guide/materials-and-lighting#step-4-enable-the-lighting-pipeline-in-the-renderer">Step 4: Enable the Lighting Pipeline in the Renderer</a></li><li class="tab-item"><a href="/guide/materials-and-lighting#step-5-add-ambient-light">Step 5: Add Ambient Light</a></li><li class="tab-item"><a href="/guide/materials-and-lighting#step-6-add-a-directional-light">Step 6: Add a Directional Light</a></li><li class="tab-item"><a href="/guide/materials-and-lighting#step-7-render-with-object-lights-and-camera">Step 7: Render with Object, Lights, and Camera</a></li><li class="tab-item"><a href="/guide/materials-and-lighting#step-8-animate-and-keep-scene-responsive">Step 8: Animate and Keep Scene Responsive</a></li><li class="tab-item"><a href="/guide/materials-and-lighting#switching-between-material-types">Switching Between Material Types</a></li><li class="tab-item"><a href="/guide/materials-and-lighting#reference-examples">Reference Examples</a></li></ul></li><li class="tab-item"><a href="/guide/textures-and-assets">What You Will Add</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/textures-and-assets#what-you-will-add">What You Will Add</a></li><li class="tab-item"><a href="/guide/textures-and-assets#step-1-import-loaders">Step 1: Import Loaders</a></li><li class="tab-item"><a href="/guide/textures-and-assets#step-2-load-a-texture">Step 2: Load a Texture</a></li><li class="tab-item"><a href="/guide/textures-and-assets#step-3-apply-the-texture-to-a-material">Step 3: Apply the Texture to a Material</a></li><li class="tab-item"><a href="/guide/textures-and-assets#step-4-load-an-obj-model">Step 4: Load an OBJ Model</a></li><li class="tab-item"><a href="/guide/textures-and-assets#step-5-optionally-patch-imported-obj-materials">Step 5: Optionally Patch Imported OBJ Materials</a></li><li class="tab-item"><a href="/guide/textures-and-assets#step-6-load-a-gltf-scene">Step 6: Load a glTF Scene</a></li><li class="tab-item"><a href="/guide/textures-and-assets#step-7-render-streaming-assets-safely">Step 7: Render Streaming Assets Safely</a></li><li class="tab-item"><a href="/guide/textures-and-assets#path-rules-that-prevent-most-loading-errors">Path Rules That Prevent Most Loading Errors</a></li><li class="tab-item"><a href="/guide/textures-and-assets#reference-examples">Reference Examples</a></li></ul></li><li class="tab-item"><a href="/guide/render-targets-and-views">Render Targets and Views</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/render-targets-and-views#what-you-will-add">What You Will Add</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#step-1-import-render-target-apis">Step 1: Import Render Target APIs</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#step-2-create-a-canvas-target-most-common">Step 2: Create a Canvas Target (Most Common)</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#step-3-render-a-scene-to-the-canvas-target">Step 3: Render a Scene to the Canvas Target</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#step-4-create-an-offscreen-image-target">Step 4: Create an Offscreen Image Target</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#step-5-render-offscreen-with-a-dedicated-camera">Step 5: Render Offscreen with a Dedicated Camera</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#step-6-use-offscreen-output-as-a-texture">Step 6: Use Offscreen Output as a Texture</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#step-7-split-canvas-with-viewports">Step 7: Split Canvas with Viewports</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#step-8-bind-cameras-to-each-view-and-render-once">Step 8: Bind Cameras to Each View and Render Once</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#step-9-use-scissor-for-hard-splitmasking">Step 9: Use Scissor for Hard Split/Masking</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#resize-rule-for-multi-view-scenes">Resize Rule for Multi-View Scenes</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#reference-examples">Reference Examples</a></li></ul></li><li class="tab-item"><a href="/guide/scene-graph-and-transforms">Scene Graph and Transforms</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/scene-graph-and-transforms#what-you-will-add">What You Will Add</a></li><li class="tab-item"><a href="/guide/scene-graph-and-transforms#step-1-import-what-you-need">Step 1: Import What You Need</a></li><li class="tab-item"><a href="/guide/scene-graph-and-transforms#step-2-create-parent-and-child-nodes">Step 2: Create Parent and Child Nodes</a></li><li class="tab-item"><a href="/guide/scene-graph-and-transforms#step-3-build-the-hierarchy">Step 3: Build the Hierarchy</a></li><li class="tab-item"><a href="/guide/scene-graph-and-transforms#step-4-set-local-transforms">Step 4: Set Local Transforms</a></li><li class="tab-item"><a href="/guide/scene-graph-and-transforms#step-5-animate-the-parent">Step 5: Animate the Parent</a></li><li class="tab-item"><a href="/guide/scene-graph-and-transforms#step-6-render-the-hierarchy">Step 6: Render the Hierarchy</a></li><li class="tab-item"><a href="/guide/scene-graph-and-transforms#traverse-the-graph-for-bulk-operations">Traverse the Graph for Bulk Operations</a></li><li class="tab-item"><a href="/guide/scene-graph-and-transforms#reparent-safely">Reparent Safely</a></li><li class="tab-item"><a href="/guide/scene-graph-and-transforms#reference-examples">Reference Examples</a></li></ul></li><li class="tab-item"><a href="/guide/plugins-and-render-pipeline" class="is-active">Plugins and Render Pipeline</a><ul class="subtabs"><li class="tab-item"><a href="/guide/plugins-and-render-pipeline#what-you-will-add">What You Will Add</a></li><li class="tab-item"><a href="/guide/plugins-and-render-pipeline#step-1-import-core-renderer-and-plugins">Step 1: Import Core Renderer and Plugins</a></li><li class="tab-item"><a href="/guide/plugins-and-render-pipeline#step-2-build-a-minimal-plugin-stack">Step 2: Build a Minimal Plugin Stack</a></li><li class="tab-item"><a href="/guide/plugins-and-render-pipeline#step-3-add-lighting-support">Step 3: Add Lighting Support</a></li><li class="tab-item"><a href="/guide/plugins-and-render-pipeline#step-4-add-shadows-and-skybox-when-needed">Step 4: Add Shadows and Skybox When Needed</a></li><li class="tab-item"><a href="/guide/plugins-and-render-pipeline#step-5-render-as-usual">Step 5: Render as Usual</a></li><li class="tab-item"><a href="/guide/plugins-and-render-pipeline#what-happens-during-render">What Happens During render()</a></li><li class="tab-item"><a href="/guide/plugins-and-render-pipeline#plugin-roles">Plugin Roles</a></li><li class="tab-item"><a href="/guide/plugins-and-render-pipeline#create-a-custom-plugin">Create a Custom Plugin</a></li></ul></li><li class="tab-item"><a href="/guide/api-map">API Map</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/api-map#quick-import-example">Quick Import Example</a></li><li class="tab-item"><a href="/guide/api-map#rendering-core">Rendering Core</a></li><li class="tab-item"><a href="/guide/api-map#scene-objects">Scene Objects</a></li><li class="tab-item"><a href="/guide/api-map#materials">Materials</a></li><li class="tab-item"><a href="/guide/api-map#lighting">Lighting</a></li><li class="tab-item"><a href="/guide/api-map#geometry-and-mesh">Geometry and Mesh</a></li><li class="tab-item"><a href="/guide/api-map#camera-and-control">Camera and Control</a></li><li class="tab-item"><a href="/guide/api-map#assets-and-textures">Assets and Textures</a></li><li class="tab-item"><a href="/guide/api-map#render-targets">Render Targets</a></li><li class="tab-item"><a href="/guide/api-map#plugins">Plugins</a></li></ul></li><li class="tab-item"><a href="/guide/troubleshooting">Troubleshooting</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/troubleshooting#blank-canvas">Blank Canvas</a></li><li class="tab-item"><a href="/guide/troubleshooting#object-is-black-or-unlit">Object Is Black or Unlit</a></li><li class="tab-item"><a href="/guide/troubleshooting#distorted-aspect-ratio">Distorted Aspect Ratio</a></li><li class="tab-item"><a href="/guide/troubleshooting#missing-textures-or-models">Missing Textures or Models</a></li><li class="tab-item"><a href="/guide/troubleshooting#shadows-not-visible">Shadows Not Visible</a></li></ul></li></ul></details></li><li class="tab-item"><a href="/examples">Examples</a></li></ul></div> </aside> <main> <h1 id="plugins-and-render-pipeline">Plugins and Render Pipeline</h1>
|
|
3
|
-
<p>This renderer is plugin-driven.
|
|
4
|
-
Plugins discover scene objects, prepare render data, and contribute render work.</p>
|
|
5
|
-
<h2 id="what-you-will-add">What You Will Add</h2>
|
|
6
|
-
<ul>
|
|
7
|
-
<li>a plugin stack for your renderer</li>
|
|
8
|
-
<li>a clear plugin order strategy</li>
|
|
9
|
-
</ul>
|
|
10
|
-
<h2 id="step-1-import-core-renderer-and-plugins">Step 1: Import Core Renderer and Plugins</h2>
|
|
11
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8; overflow-x: auto;" tabindex="0" data-language="js"><code><span class="line"><span style="color:#F97583">import</span><span style="color:#E1E4E8"> {</span></span>
|
|
12
|
-
<span class="line"><span style="color:#E1E4E8"> WebGLRenderer,</span></span>
|
|
13
|
-
<span class="line"><span style="color:#E1E4E8"> CameraPlugin,</span></span>
|
|
14
|
-
<span class="line"><span style="color:#E1E4E8"> MeshMaterialPlugin,</span></span>
|
|
15
|
-
<span class="line"><span style="color:#E1E4E8"> LightPlugin,</span></span>
|
|
16
|
-
<span class="line"><span style="color:#E1E4E8"> ShadowPlugin,</span></span>
|
|
17
|
-
<span class="line"><span style="color:#E1E4E8"> SkyboxPlugin</span></span>
|
|
18
|
-
<span class="line"><span style="color:#E1E4E8">} </span><span style="color:#F97583">from</span><span style="color:#9ECBFF"> "chorama"</span><span style="color:#E1E4E8">;</span></span></code></pre>
|
|
19
|
-
<p>Start with the smallest plugin set your scene needs.
|
|
20
|
-
Add others only when features require them.</p>
|
|
21
|
-
<h2 id="step-2-build-a-minimal-plugin-stack">Step 2: Build a Minimal Plugin Stack</h2>
|
|
22
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8; overflow-x: auto;" tabindex="0" data-language="js"><code><span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> renderer</span><span style="color:#F97583"> =</span><span style="color:#F97583"> new</span><span style="color:#B392F0"> WebGLRenderer</span><span style="color:#E1E4E8">({</span></span>
|
|
23
|
-
<span class="line"><span style="color:#E1E4E8"> plugins: [</span></span>
|
|
24
|
-
<span class="line"><span style="color:#F97583"> new</span><span style="color:#B392F0"> MeshMaterialPlugin</span><span style="color:#E1E4E8">(),</span></span>
|
|
25
|
-
<span class="line"><span style="color:#F97583"> new</span><span style="color:#B392F0"> CameraPlugin</span><span style="color:#E1E4E8">()</span></span>
|
|
26
|
-
<span class="line"><span style="color:#E1E4E8"> ]</span></span>
|
|
27
|
-
<span class="line"><span style="color:#E1E4E8">});</span></span></code></pre>
|
|
28
|
-
<p>This stack is enough for camera + mesh/material scenes without lighting.</p>
|
|
29
|
-
<h2 id="step-3-add-lighting-support">Step 3: Add Lighting Support</h2>
|
|
30
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8; overflow-x: auto;" tabindex="0" data-language="js"><code><span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> renderer</span><span style="color:#F97583"> =</span><span style="color:#F97583"> new</span><span style="color:#B392F0"> WebGLRenderer</span><span style="color:#E1E4E8">({</span></span>
|
|
31
|
-
<span class="line"><span style="color:#E1E4E8"> plugins: [</span></span>
|
|
32
|
-
<span class="line"><span style="color:#F97583"> new</span><span style="color:#B392F0"> LightPlugin</span><span style="color:#E1E4E8">(),</span></span>
|
|
33
|
-
<span class="line"><span style="color:#F97583"> new</span><span style="color:#B392F0"> MeshMaterialPlugin</span><span style="color:#E1E4E8">(),</span></span>
|
|
34
|
-
<span class="line"><span style="color:#F97583"> new</span><span style="color:#B392F0"> CameraPlugin</span><span style="color:#E1E4E8">()</span></span>
|
|
35
|
-
<span class="line"><span style="color:#E1E4E8"> ]</span></span>
|
|
36
|
-
<span class="line"><span style="color:#E1E4E8">});</span></span></code></pre>
|
|
37
|
-
<p><code>LightPlugin</code> provides light uniform data for lit shaders.
|
|
38
|
-
Without it, lit materials may render incorrectly.</p>
|
|
39
|
-
<h2 id="step-4-add-shadows-and-skybox-when-needed">Step 4: Add Shadows and Skybox When Needed</h2>
|
|
40
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8; overflow-x: auto;" tabindex="0" data-language="js"><code><span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> renderer</span><span style="color:#F97583"> =</span><span style="color:#F97583"> new</span><span style="color:#B392F0"> WebGLRenderer</span><span style="color:#E1E4E8">({</span></span>
|
|
41
|
-
<span class="line"><span style="color:#E1E4E8"> plugins: [</span></span>
|
|
42
|
-
<span class="line"><span style="color:#F97583"> new</span><span style="color:#B392F0"> ShadowPlugin</span><span style="color:#E1E4E8">(),</span></span>
|
|
43
|
-
<span class="line"><span style="color:#F97583"> new</span><span style="color:#B392F0"> LightPlugin</span><span style="color:#E1E4E8">(),</span></span>
|
|
44
|
-
<span class="line"><span style="color:#F97583"> new</span><span style="color:#B392F0"> SkyboxPlugin</span><span style="color:#E1E4E8">(),</span></span>
|
|
45
|
-
<span class="line"><span style="color:#F97583"> new</span><span style="color:#B392F0"> MeshMaterialPlugin</span><span style="color:#E1E4E8">(),</span></span>
|
|
46
|
-
<span class="line"><span style="color:#F97583"> new</span><span style="color:#B392F0"> CameraPlugin</span><span style="color:#E1E4E8">()</span></span>
|
|
47
|
-
<span class="line"><span style="color:#E1E4E8"> ]</span></span>
|
|
48
|
-
<span class="line"><span style="color:#E1E4E8">});</span></span></code></pre>
|
|
49
|
-
<p>Use this fuller stack only when your scene needs shadows/skybox.
|
|
50
|
-
It is heavier than the minimal stack.</p>
|
|
51
|
-
<h2 id="step-5-render-as-usual">Step 5: Render as Usual</h2>
|
|
52
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8; overflow-x: auto;" tabindex="0" data-language="js"><code><span class="line"><span style="color:#E1E4E8">renderer.</span><span style="color:#B392F0">render</span><span style="color:#E1E4E8">(objects, device);</span></span></code></pre>
|
|
53
|
-
<p>The pipeline stays behind this single call.
|
|
54
|
-
You choose behavior by changing plugins and scene objects.</p>
|
|
55
|
-
<h2 id="what-happens-during-render">What Happens During <code>render()</code></h2>
|
|
56
|
-
<p>High-level flow:</p>
|
|
57
|
-
<ol>
|
|
58
|
-
<li>Object transforms are updated through scene traversal.</li>
|
|
59
|
-
<li>Each plugin preprocesses scene data.</li>
|
|
60
|
-
<li>Plugins contribute views/render items.</li>
|
|
61
|
-
<li>Views are sorted and rendered.</li>
|
|
62
|
-
</ol>
|
|
63
|
-
<p>This is why missing plugins often look like “nothing happens” rather than hard errors.</p>
|
|
64
|
-
<h2 id="plugin-roles">Plugin Roles</h2>
|
|
65
|
-
<ul>
|
|
66
|
-
<li><code>CameraPlugin</code>: creates camera views and per-view camera data.</li>
|
|
67
|
-
<li><code>MeshMaterialPlugin</code>: converts <code>MeshMaterial3D</code> objects into draw items.</li>
|
|
68
|
-
<li><code>LightPlugin</code>: collects light objects and uploads light blocks.</li>
|
|
69
|
-
<li><code>ShadowPlugin</code>: builds shadow passes/resources for shadow-casting lights.</li>
|
|
70
|
-
<li><code>SkyboxPlugin</code>: adds skybox rendering behavior.</li>
|
|
71
|
-
</ul>
|
|
72
|
-
<h2 id="create-a-custom-plugin">Create a Custom Plugin</h2>
|
|
73
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8; overflow-x: auto;" tabindex="0" data-language="js"><code><span class="line"><span style="color:#F97583">class</span><span style="color:#B392F0"> MyPlugin</span><span style="color:#F97583"> extends</span><span style="color:#B392F0"> Plugin</span><span style="color:#E1E4E8"> {</span></span>
|
|
74
|
-
<span class="line"><span style="color:#B392F0"> init</span><span style="color:#E1E4E8">(</span><span style="color:#FFAB70">renderer</span><span style="color:#E1E4E8">) {</span></span>
|
|
75
|
-
<span class="line"><span style="color:#6A737D"> // register resources, shader defines, or view fillers</span></span>
|
|
76
|
-
<span class="line"><span style="color:#E1E4E8"> }</span></span>
|
|
77
|
-
<span class="line"></span>
|
|
78
|
-
<span class="line"><span style="color:#B392F0"> preprocess</span><span style="color:#E1E4E8">(</span><span style="color:#FFAB70">objects</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">device</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">renderer</span><span style="color:#E1E4E8">) {</span></span>
|
|
79
|
-
<span class="line"><span style="color:#6A737D"> // inspect scene, prepare data, push views/resources</span></span>
|
|
80
|
-
<span class="line"><span style="color:#E1E4E8"> }</span></span>
|
|
81
|
-
<span class="line"></span>
|
|
82
|
-
<span class="line"><span style="color:#B392F0"> getRenderItem</span><span style="color:#E1E4E8">(</span><span style="color:#FFAB70">object</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">device</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">renderer</span><span style="color:#E1E4E8">) {</span></span>
|
|
83
|
-
<span class="line"><span style="color:#6A737D"> // return a render item for supported object types</span></span>
|
|
84
|
-
<span class="line"><span style="color:#F97583"> return</span><span style="color:#79B8FF"> undefined</span><span style="color:#E1E4E8">;</span></span>
|
|
85
|
-
<span class="line"><span style="color:#E1E4E8"> }</span></span>
|
|
86
|
-
<span class="line"><span style="color:#E1E4E8">}</span></span></code></pre>
|
|
87
|
-
<p>A custom plugin should solve one focused concern.
|
|
88
|
-
Avoid mixing unrelated responsibilities in one plugin.</p>
|
|
89
|
-
</main> </div> <script type="module">var e=document.getElementById(`menu-toggle`);e?.addEventListener(`click`,()=>{let t=document.body.classList.toggle(`menu-open`);e.setAttribute(`aria-expanded`,t?`true`:`false`)});var t=document.getElementById(`site-sidebar`);if(t instanceof HTMLElement){let e=window.location.pathname.replace(/\/+$/,``)||`/`,n=`sidebar-scroll:${e===`/`?`/`:e.split(`/`)[1]||e}`,r=0,i=()=>{try{let e=sessionStorage.getItem(n);return e===null?null:Number.parseInt(e,10)}catch{return null}},a=()=>{try{sessionStorage.setItem(n,String(t.scrollTop))}catch{}r=0},o=()=>{r===0&&(r=window.requestAnimationFrame(a))},s=i();s!==null&&Number.isFinite(s)&&(t.scrollTop=s),t.addEventListener(`scroll`,o,{passive:!0}),window.addEventListener(`pagehide`,a),window.addEventListener(`beforeunload`,a)}</script></body> </html>
|
|
@@ -1,95 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html> <html lang="en"> <head><meta charset="UTF-8"><meta name="viewport" content="width=device-width"><meta name="generator" content="Astro v7.2.2"><title>Render Targets and Views | chorama</title><style>.category-section[data-astro-cid-mzi2nk5r]+.category-section[data-astro-cid-mzi2nk5r]{margin-top:2rem}.category-section[data-astro-cid-mzi2nk5r] h2[data-astro-cid-mzi2nk5r]{margin-bottom:.75rem}.examples-grid[data-astro-cid-mzi2nk5r]{grid-template-columns:repeat(auto-fill,minmax(220px,1fr));gap:1rem;margin-top:1.5rem;display:grid}.example-card[data-astro-cid-mzi2nk5r]{aspect-ratio:4/3;border:1px solid var(--border);background:var(--surface-2);border-radius:0;text-decoration:none;display:block;position:relative;overflow:hidden}.example-card[data-astro-cid-mzi2nk5r] img[data-astro-cid-mzi2nk5r]{object-fit:cover;width:100%;height:100%;display:block}.example-card[data-astro-cid-mzi2nk5r] span[data-astro-cid-mzi2nk5r]{text-align:center;color:#fff;background:linear-gradient(#00000026,#000c);padding:.55rem .75rem;font-weight:700;position:absolute;bottom:0;left:0;right:0}.example-frame[data-astro-cid-mxkslj3q]{width:100%;margin-bottom:1.25rem;position:relative}.example-link[data-astro-cid-mxkslj3q]{z-index:1;color:var(--accent);background:#00000059;border-radius:0;padding:.2rem .5rem;font-weight:600;text-decoration:underline;position:absolute;top:7rem;left:50%;transform:translate(-50%)}.example-link[data-astro-cid-mxkslj3q]:hover{color:var(--accent-secondary)}.source-code[data-astro-cid-mxkslj3q]{outline:1px solid var(--border);outline-offset:0;border-radius:0;overflow:hidden}.example-preview[data-astro-cid-mxkslj3q]{border:1px solid var(--border);background:#fff;border-radius:0;width:100%;height:560px;margin:0 0 1.25rem;display:block}.source-code[data-astro-cid-mxkslj3q] .astro-code{border:0!important;border-radius:0!important}.source-code[data-astro-cid-mxkslj3q] pre{padding:10px;margin:0!important}
|
|
2
|
-
</style><link rel="stylesheet" href="/_astro/DocLayout.BsV7p0dY.css"></head> <body> <div class="shell"> <button class="menu-toggle" id="menu-toggle" type="button" aria-label="Toggle menu" aria-expanded="false" aria-controls="site-sidebar"> <span></span> <span></span> <span></span> </button> <aside id="site-sidebar" aria-label="Sidebar navigation"> <p class="tabs-title">Navigation</p> <div><ul class="tabs"><li class="tab-item"><details class="tab-group"><summary class="tab-toggle"><span>Introduction</span><span class="chevron">›</span></summary><ul class="tabs"><li class="tab-item"><a href="/#features">Features</a></li><li class="tab-item"><a href="/#who-this-is-for">Who This Is For</a></li><li class="tab-item"><a href="/#getting-started">Getting Started</a><ul class="subtabs" hidden><li class="tab-item"><a href="/#requirements">Requirements</a></li><li class="tab-item"><a href="/#install-dependencies">Install dependencies</a></li><li class="tab-item"><a href="/#build-library-bundles">Build library bundles</a></li><li class="tab-item"><a href="/#run-demos">Run demos</a></li></ul></li><li class="tab-item"><a href="/#core-usage-flow">Core Usage Flow</a></li></ul></details></li><li class="tab-item"><details class="tab-group" open><summary class="tab-toggle is-active"><span>Guide</span><span class="chevron">›</span></summary><ul class="tabs"><li class="tab-item"><a href="/guide">Overview</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide#who-this-guide-is-for">Who This Guide Is For</a></li><li class="tab-item"><a href="/guide#how-to-use-this-guide">How To Use This Guide</a></li><li class="tab-item"><a href="/guide#reading-order">Reading Order</a></li><li class="tab-item"><a href="/guide#core-flow">Core Flow</a></li></ul></li><li class="tab-item"><a href="/guide/installation">Installation</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/installation#npm">NPM</a></li><li class="tab-item"><a href="/guide/installation#cdn">CDN</a></li><li class="tab-item"><a href="/guide/installation#manual-installation">Manual Installation</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/installation#1-requirements">Requirements</a></li><li class="tab-item"><a href="/guide/installation#2-clone-the-repository-and-install-dependencies">Clone the repository and install dependencies</a></li><li class="tab-item"><a href="/guide/installation#3-build-the-library-files">Build the library files</a></li><li class="tab-item"><a href="/guide/installation#4-copy-files-to-your-project">Copy files to your project</a></li><li class="tab-item"><a href="/guide/installation#5-use-in-your-project">Use in your project</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/installation#esm-recommended">ESM (recommended)</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/installation#vite-viteconfigjs">Vite (vite.config.js)</a></li><li class="tab-item"><a href="/guide/installation#webpack-webpackconfigjs">Webpack (webpack.config.js)</a></li></ul></li><li class="tab-item"><a href="/guide/installation#plain-html-with-browser-import-maps-no-bundler">Plain HTML with browser import maps (no bundler)</a></li><li class="tab-item"><a href="/guide/installation#plain-html-with-script-tag-umd">Plain HTML with script tag (UMD)</a></li></ul></li></ul></li></ul></li><li class="tab-item"><a href="/guide/first-scene">First Scene</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/first-scene#what-you-will-build">What You Will Build</a></li><li class="tab-item"><a href="/guide/first-scene#before-you-start">Before You Start</a></li><li class="tab-item"><a href="/guide/first-scene#build-your-first-scene">Build Your first scene</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/first-scene#step-1-import-what-you-need">Step 1: Import what you need</a></li><li class="tab-item"><a href="/guide/first-scene#step-2-create-and-mount-a-canvas">Step 2: Create and mount a canvas</a></li><li class="tab-item"><a href="/guide/first-scene#step-3-create-device-and-render-target">Step 3: Create device and render target</a></li><li class="tab-item"><a href="/guide/first-scene#step-4-create-renderer-and-required-plugins">Step 4: Create renderer and required plugins</a></li><li class="tab-item"><a href="/guide/first-scene#step-5-create-and-position-a-camera">Step 5: Create and position a camera</a></li><li class="tab-item"><a href="/guide/first-scene#step-6-create-a-cube-object">Step 6: Create a cube object</a></li><li class="tab-item"><a href="/guide/first-scene#step-7-define-per-frame-rotation">Step 7: Define per-frame rotation</a></li><li class="tab-item"><a href="/guide/first-scene#step-8-add-resize-handling">Step 8: Add resize handling</a></li><li class="tab-item"><a href="/guide/first-scene#step-9-start-the-render-loop">Step 9: Start the render loop</a></li></ul></li><li class="tab-item"><a href="/guide/first-scene#what-you-can-try-next">What You Can Try Next</a></li><li class="tab-item"><a href="/guide/first-scene#reference-example">Reference Example</a></li></ul></li><li class="tab-item"><a href="/guide/camera-and-controls">Camera and Controls</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/camera-and-controls#what-you-will-add">What You Will Add</a></li><li class="tab-item"><a href="/guide/camera-and-controls#step-1-import-camera-apis">Step 1: Import Camera APIs</a></li><li class="tab-item"><a href="/guide/camera-and-controls#step-2-create-a-camera">Step 2: Create a Camera</a></li><li class="tab-item"><a href="/guide/camera-and-controls#step-3-configure-perspective-projection">Step 3: Configure Perspective Projection</a></li><li class="tab-item"><a href="/guide/camera-and-controls#step-4-add-orbit-controls">Step 4: Add Orbit Controls</a></li><li class="tab-item"><a href="/guide/camera-and-controls#step-5-update-controls-in-the-frame-loop">Step 5: Update Controls in the Frame Loop</a></li><li class="tab-item"><a href="/guide/camera-and-controls#switch-to-orthographic-projection">Switch to Orthographic Projection</a></li><li class="tab-item"><a href="/guide/camera-and-controls#reference-examples">Reference Examples</a></li></ul></li><li class="tab-item"><a href="/guide/materials-and-lighting">Materials and Lighting</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/materials-and-lighting#what-you-will-add">What You Will Add</a></li><li class="tab-item"><a href="/guide/materials-and-lighting#step-1-import-material-and-light-apis">Step 1: Import Material and Light APIs</a></li><li class="tab-item"><a href="/guide/materials-and-lighting#step-2-pick-a-material-model">Step 2: Pick a Material Model</a></li><li class="tab-item"><a href="/guide/materials-and-lighting#step-3-apply-the-material-to-your-mesh-object">Step 3: Apply the Material to Your Mesh Object</a></li><li class="tab-item"><a href="/guide/materials-and-lighting#step-4-enable-the-lighting-pipeline-in-the-renderer">Step 4: Enable the Lighting Pipeline in the Renderer</a></li><li class="tab-item"><a href="/guide/materials-and-lighting#step-5-add-ambient-light">Step 5: Add Ambient Light</a></li><li class="tab-item"><a href="/guide/materials-and-lighting#step-6-add-a-directional-light">Step 6: Add a Directional Light</a></li><li class="tab-item"><a href="/guide/materials-and-lighting#step-7-render-with-object-lights-and-camera">Step 7: Render with Object, Lights, and Camera</a></li><li class="tab-item"><a href="/guide/materials-and-lighting#step-8-animate-and-keep-scene-responsive">Step 8: Animate and Keep Scene Responsive</a></li><li class="tab-item"><a href="/guide/materials-and-lighting#switching-between-material-types">Switching Between Material Types</a></li><li class="tab-item"><a href="/guide/materials-and-lighting#reference-examples">Reference Examples</a></li></ul></li><li class="tab-item"><a href="/guide/textures-and-assets">What You Will Add</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/textures-and-assets#what-you-will-add">What You Will Add</a></li><li class="tab-item"><a href="/guide/textures-and-assets#step-1-import-loaders">Step 1: Import Loaders</a></li><li class="tab-item"><a href="/guide/textures-and-assets#step-2-load-a-texture">Step 2: Load a Texture</a></li><li class="tab-item"><a href="/guide/textures-and-assets#step-3-apply-the-texture-to-a-material">Step 3: Apply the Texture to a Material</a></li><li class="tab-item"><a href="/guide/textures-and-assets#step-4-load-an-obj-model">Step 4: Load an OBJ Model</a></li><li class="tab-item"><a href="/guide/textures-and-assets#step-5-optionally-patch-imported-obj-materials">Step 5: Optionally Patch Imported OBJ Materials</a></li><li class="tab-item"><a href="/guide/textures-and-assets#step-6-load-a-gltf-scene">Step 6: Load a glTF Scene</a></li><li class="tab-item"><a href="/guide/textures-and-assets#step-7-render-streaming-assets-safely">Step 7: Render Streaming Assets Safely</a></li><li class="tab-item"><a href="/guide/textures-and-assets#path-rules-that-prevent-most-loading-errors">Path Rules That Prevent Most Loading Errors</a></li><li class="tab-item"><a href="/guide/textures-and-assets#reference-examples">Reference Examples</a></li></ul></li><li class="tab-item"><a href="/guide/render-targets-and-views" class="is-active">Render Targets and Views</a><ul class="subtabs"><li class="tab-item"><a href="/guide/render-targets-and-views#what-you-will-add">What You Will Add</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#step-1-import-render-target-apis">Step 1: Import Render Target APIs</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#step-2-create-a-canvas-target-most-common">Step 2: Create a Canvas Target (Most Common)</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#step-3-render-a-scene-to-the-canvas-target">Step 3: Render a Scene to the Canvas Target</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#step-4-create-an-offscreen-image-target">Step 4: Create an Offscreen Image Target</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#step-5-render-offscreen-with-a-dedicated-camera">Step 5: Render Offscreen with a Dedicated Camera</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#step-6-use-offscreen-output-as-a-texture">Step 6: Use Offscreen Output as a Texture</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#step-7-split-canvas-with-viewports">Step 7: Split Canvas with Viewports</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#step-8-bind-cameras-to-each-view-and-render-once">Step 8: Bind Cameras to Each View and Render Once</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#step-9-use-scissor-for-hard-splitmasking">Step 9: Use Scissor for Hard Split/Masking</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#resize-rule-for-multi-view-scenes">Resize Rule for Multi-View Scenes</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#reference-examples">Reference Examples</a></li></ul></li><li class="tab-item"><a href="/guide/scene-graph-and-transforms">Scene Graph and Transforms</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/scene-graph-and-transforms#what-you-will-add">What You Will Add</a></li><li class="tab-item"><a href="/guide/scene-graph-and-transforms#step-1-import-what-you-need">Step 1: Import What You Need</a></li><li class="tab-item"><a href="/guide/scene-graph-and-transforms#step-2-create-parent-and-child-nodes">Step 2: Create Parent and Child Nodes</a></li><li class="tab-item"><a href="/guide/scene-graph-and-transforms#step-3-build-the-hierarchy">Step 3: Build the Hierarchy</a></li><li class="tab-item"><a href="/guide/scene-graph-and-transforms#step-4-set-local-transforms">Step 4: Set Local Transforms</a></li><li class="tab-item"><a href="/guide/scene-graph-and-transforms#step-5-animate-the-parent">Step 5: Animate the Parent</a></li><li class="tab-item"><a href="/guide/scene-graph-and-transforms#step-6-render-the-hierarchy">Step 6: Render the Hierarchy</a></li><li class="tab-item"><a href="/guide/scene-graph-and-transforms#traverse-the-graph-for-bulk-operations">Traverse the Graph for Bulk Operations</a></li><li class="tab-item"><a href="/guide/scene-graph-and-transforms#reparent-safely">Reparent Safely</a></li><li class="tab-item"><a href="/guide/scene-graph-and-transforms#reference-examples">Reference Examples</a></li></ul></li><li class="tab-item"><a href="/guide/plugins-and-render-pipeline">Plugins and Render Pipeline</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/plugins-and-render-pipeline#what-you-will-add">What You Will Add</a></li><li class="tab-item"><a href="/guide/plugins-and-render-pipeline#step-1-import-core-renderer-and-plugins">Step 1: Import Core Renderer and Plugins</a></li><li class="tab-item"><a href="/guide/plugins-and-render-pipeline#step-2-build-a-minimal-plugin-stack">Step 2: Build a Minimal Plugin Stack</a></li><li class="tab-item"><a href="/guide/plugins-and-render-pipeline#step-3-add-lighting-support">Step 3: Add Lighting Support</a></li><li class="tab-item"><a href="/guide/plugins-and-render-pipeline#step-4-add-shadows-and-skybox-when-needed">Step 4: Add Shadows and Skybox When Needed</a></li><li class="tab-item"><a href="/guide/plugins-and-render-pipeline#step-5-render-as-usual">Step 5: Render as Usual</a></li><li class="tab-item"><a href="/guide/plugins-and-render-pipeline#what-happens-during-render">What Happens During render()</a></li><li class="tab-item"><a href="/guide/plugins-and-render-pipeline#plugin-roles">Plugin Roles</a></li><li class="tab-item"><a href="/guide/plugins-and-render-pipeline#create-a-custom-plugin">Create a Custom Plugin</a></li></ul></li><li class="tab-item"><a href="/guide/api-map">API Map</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/api-map#quick-import-example">Quick Import Example</a></li><li class="tab-item"><a href="/guide/api-map#rendering-core">Rendering Core</a></li><li class="tab-item"><a href="/guide/api-map#scene-objects">Scene Objects</a></li><li class="tab-item"><a href="/guide/api-map#materials">Materials</a></li><li class="tab-item"><a href="/guide/api-map#lighting">Lighting</a></li><li class="tab-item"><a href="/guide/api-map#geometry-and-mesh">Geometry and Mesh</a></li><li class="tab-item"><a href="/guide/api-map#camera-and-control">Camera and Control</a></li><li class="tab-item"><a href="/guide/api-map#assets-and-textures">Assets and Textures</a></li><li class="tab-item"><a href="/guide/api-map#render-targets">Render Targets</a></li><li class="tab-item"><a href="/guide/api-map#plugins">Plugins</a></li></ul></li><li class="tab-item"><a href="/guide/troubleshooting">Troubleshooting</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/troubleshooting#blank-canvas">Blank Canvas</a></li><li class="tab-item"><a href="/guide/troubleshooting#object-is-black-or-unlit">Object Is Black or Unlit</a></li><li class="tab-item"><a href="/guide/troubleshooting#distorted-aspect-ratio">Distorted Aspect Ratio</a></li><li class="tab-item"><a href="/guide/troubleshooting#missing-textures-or-models">Missing Textures or Models</a></li><li class="tab-item"><a href="/guide/troubleshooting#shadows-not-visible">Shadows Not Visible</a></li></ul></li></ul></details></li><li class="tab-item"><a href="/examples">Examples</a></li></ul></div> </aside> <main> <h1 id="render-targets-and-views">Render Targets and Views</h1>
|
|
3
|
-
<p>This guide assumes you already have a scene rendering from <a href="/guide/first-scene">First Scene</a>.
|
|
4
|
-
Here, we focus on where the camera renders and how to split output.</p>
|
|
5
|
-
<h2 id="what-you-will-add">What You Will Add</h2>
|
|
6
|
-
<ul>
|
|
7
|
-
<li>a canvas render target</li>
|
|
8
|
-
<li>an offscreen image render target</li>
|
|
9
|
-
<li>viewport/scissor based view layouts</li>
|
|
10
|
-
</ul>
|
|
11
|
-
<h2 id="step-1-import-render-target-apis">Step 1: Import Render Target APIs</h2>
|
|
12
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8; overflow-x: auto;" tabindex="0" data-language="js"><code><span class="line"><span style="color:#F97583">import</span><span style="color:#E1E4E8"> {</span></span>
|
|
13
|
-
<span class="line"><span style="color:#E1E4E8"> CanvasTarget,</span></span>
|
|
14
|
-
<span class="line"><span style="color:#E1E4E8"> ImageRenderTarget,</span></span>
|
|
15
|
-
<span class="line"><span style="color:#E1E4E8"> ViewRectangle,</span></span>
|
|
16
|
-
<span class="line"><span style="color:#E1E4E8"> Texture,</span></span>
|
|
17
|
-
<span class="line"><span style="color:#E1E4E8"> TextureType,</span></span>
|
|
18
|
-
<span class="line"><span style="color:#E1E4E8"> TextureFormat,</span></span>
|
|
19
|
-
<span class="line"><span style="color:#E1E4E8"> Camera</span></span>
|
|
20
|
-
<span class="line"><span style="color:#E1E4E8">} </span><span style="color:#F97583">from</span><span style="color:#9ECBFF"> "chorama"</span><span style="color:#E1E4E8">;</span></span></code></pre>
|
|
21
|
-
<p>Use <code>CanvasTarget</code> for on-screen output.
|
|
22
|
-
Use <code>ImageRenderTarget</code> for offscreen passes.</p>
|
|
23
|
-
<h2 id="step-2-create-a-canvas-target-most-common">Step 2: Create a Canvas Target (Most Common)</h2>
|
|
24
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8; overflow-x: auto;" tabindex="0" data-language="js"><code><span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> canvasTarget</span><span style="color:#F97583"> =</span><span style="color:#F97583"> new</span><span style="color:#B392F0"> CanvasTarget</span><span style="color:#E1E4E8">(canvas);</span></span>
|
|
25
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> camera</span><span style="color:#F97583"> =</span><span style="color:#F97583"> new</span><span style="color:#B392F0"> Camera</span><span style="color:#E1E4E8">(canvasTarget);</span></span></code></pre>
|
|
26
|
-
<p>This is the default path for rendering directly to the page.</p>
|
|
27
|
-
<h2 id="step-3-render-a-scene-to-the-canvas-target">Step 3: Render a Scene to the Canvas Target</h2>
|
|
28
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8; overflow-x: auto;" tabindex="0" data-language="js"><code><span class="line"><span style="color:#E1E4E8">renderer.</span><span style="color:#B392F0">render</span><span style="color:#E1E4E8">([object, camera], device);</span></span></code></pre>
|
|
29
|
-
<p>If your scene is blank, first confirm the camera uses the expected target.</p>
|
|
30
|
-
<h2 id="step-4-create-an-offscreen-image-target">Step 4: Create an Offscreen Image Target</h2>
|
|
31
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8; overflow-x: auto;" tabindex="0" data-language="js"><code><span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> imageTarget</span><span style="color:#F97583"> =</span><span style="color:#F97583"> new</span><span style="color:#B392F0"> ImageRenderTarget</span><span style="color:#E1E4E8">({</span></span>
|
|
32
|
-
<span class="line"><span style="color:#E1E4E8"> width: </span><span style="color:#79B8FF">1024</span><span style="color:#E1E4E8">,</span></span>
|
|
33
|
-
<span class="line"><span style="color:#E1E4E8"> height: </span><span style="color:#79B8FF">1024</span><span style="color:#E1E4E8">,</span></span>
|
|
34
|
-
<span class="line"><span style="color:#E1E4E8"> color: [</span></span>
|
|
35
|
-
<span class="line"><span style="color:#F97583"> new</span><span style="color:#B392F0"> Texture</span><span style="color:#E1E4E8">({</span></span>
|
|
36
|
-
<span class="line"><span style="color:#E1E4E8"> type: TextureType.Texture2D,</span></span>
|
|
37
|
-
<span class="line"><span style="color:#E1E4E8"> format: TextureFormat.RGBA8Unorm,</span></span>
|
|
38
|
-
<span class="line"><span style="color:#E1E4E8"> width: </span><span style="color:#79B8FF">1024</span><span style="color:#E1E4E8">,</span></span>
|
|
39
|
-
<span class="line"><span style="color:#E1E4E8"> height: </span><span style="color:#79B8FF">1024</span></span>
|
|
40
|
-
<span class="line"><span style="color:#E1E4E8"> })</span></span>
|
|
41
|
-
<span class="line"><span style="color:#E1E4E8"> ],</span></span>
|
|
42
|
-
<span class="line"><span style="color:#E1E4E8"> internalDepthStencil: TextureFormat.Depth24PlusStencil8</span></span>
|
|
43
|
-
<span class="line"><span style="color:#E1E4E8">});</span></span></code></pre>
|
|
44
|
-
<p>This creates a texture-backed target you can render into.</p>
|
|
45
|
-
<h2 id="step-5-render-offscreen-with-a-dedicated-camera">Step 5: Render Offscreen with a Dedicated Camera</h2>
|
|
46
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8; overflow-x: auto;" tabindex="0" data-language="js"><code><span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> offscreenCamera</span><span style="color:#F97583"> =</span><span style="color:#F97583"> new</span><span style="color:#B392F0"> Camera</span><span style="color:#E1E4E8">(imageTarget);</span></span>
|
|
47
|
-
<span class="line"><span style="color:#E1E4E8">renderer.</span><span style="color:#B392F0">render</span><span style="color:#E1E4E8">([offscreenObject, offscreenCamera], device);</span></span></code></pre>
|
|
48
|
-
<p>Use a separate camera when offscreen pass framing differs from main pass.</p>
|
|
49
|
-
<h2 id="step-6-use-offscreen-output-as-a-texture">Step 6: Use Offscreen Output as a Texture</h2>
|
|
50
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8; overflow-x: auto;" tabindex="0" data-language="js"><code><span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> screenObject</span><span style="color:#F97583"> =</span><span style="color:#F97583"> new</span><span style="color:#B392F0"> MeshMaterial3D</span><span style="color:#E1E4E8">(</span></span>
|
|
51
|
-
<span class="line"><span style="color:#E1E4E8"> mesh,</span></span>
|
|
52
|
-
<span class="line"><span style="color:#F97583"> new</span><span style="color:#B392F0"> BasicMaterial</span><span style="color:#E1E4E8">({ mainTexture: imageTarget.color[</span><span style="color:#79B8FF">0</span><span style="color:#E1E4E8">] })</span></span>
|
|
53
|
-
<span class="line"><span style="color:#E1E4E8">);</span></span>
|
|
54
|
-
<span class="line"></span>
|
|
55
|
-
<span class="line"><span style="color:#E1E4E8">renderer.</span><span style="color:#B392F0">render</span><span style="color:#E1E4E8">([screenObject, camera], device);</span></span></code></pre>
|
|
56
|
-
<p>This is the core pattern for mirrors, portals, and postprocessing chains.</p>
|
|
57
|
-
<h2 id="step-7-split-canvas-with-viewports">Step 7: Split Canvas with Viewports</h2>
|
|
58
|
-
<p>Use multiple <code>CanvasTarget</code> instances on the same canvas.</p>
|
|
59
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8; overflow-x: auto;" tabindex="0" data-language="js"><code><span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> leftTarget</span><span style="color:#F97583"> =</span><span style="color:#F97583"> new</span><span style="color:#B392F0"> CanvasTarget</span><span style="color:#E1E4E8">(canvas);</span></span>
|
|
60
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> rightTarget</span><span style="color:#F97583"> =</span><span style="color:#F97583"> new</span><span style="color:#B392F0"> CanvasTarget</span><span style="color:#E1E4E8">(canvas);</span></span>
|
|
61
|
-
<span class="line"></span>
|
|
62
|
-
<span class="line"><span style="color:#E1E4E8">leftTarget.viewport.offset.</span><span style="color:#B392F0">set</span><span style="color:#E1E4E8">(</span><span style="color:#79B8FF">0</span><span style="color:#E1E4E8">, </span><span style="color:#79B8FF">0</span><span style="color:#E1E4E8">);</span></span>
|
|
63
|
-
<span class="line"><span style="color:#E1E4E8">leftTarget.viewport.size.</span><span style="color:#B392F0">set</span><span style="color:#E1E4E8">(</span><span style="color:#79B8FF">0.5</span><span style="color:#E1E4E8">, </span><span style="color:#79B8FF">1</span><span style="color:#E1E4E8">);</span></span>
|
|
64
|
-
<span class="line"></span>
|
|
65
|
-
<span class="line"><span style="color:#E1E4E8">rightTarget.viewport.offset.</span><span style="color:#B392F0">set</span><span style="color:#E1E4E8">(</span><span style="color:#79B8FF">0.5</span><span style="color:#E1E4E8">, </span><span style="color:#79B8FF">0</span><span style="color:#E1E4E8">);</span></span>
|
|
66
|
-
<span class="line"><span style="color:#E1E4E8">rightTarget.viewport.size.</span><span style="color:#B392F0">set</span><span style="color:#E1E4E8">(</span><span style="color:#79B8FF">0.5</span><span style="color:#E1E4E8">, </span><span style="color:#79B8FF">1</span><span style="color:#E1E4E8">);</span></span></code></pre>
|
|
67
|
-
<p>Viewport values are normalized (0 to 1) relative to full canvas size.</p>
|
|
68
|
-
<h2 id="step-8-bind-cameras-to-each-view-and-render-once">Step 8: Bind Cameras to Each View and Render Once</h2>
|
|
69
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8; overflow-x: auto;" tabindex="0" data-language="js"><code><span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> leftCamera</span><span style="color:#F97583"> =</span><span style="color:#F97583"> new</span><span style="color:#B392F0"> Camera</span><span style="color:#E1E4E8">(leftTarget);</span></span>
|
|
70
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> rightCamera</span><span style="color:#F97583"> =</span><span style="color:#F97583"> new</span><span style="color:#B392F0"> Camera</span><span style="color:#E1E4E8">(rightTarget);</span></span>
|
|
71
|
-
<span class="line"></span>
|
|
72
|
-
<span class="line"><span style="color:#E1E4E8">renderer.</span><span style="color:#B392F0">render</span><span style="color:#E1E4E8">([scene, leftCamera, rightCamera], device);</span></span></code></pre>
|
|
73
|
-
<p>This gives independent camera views in a single canvas. If a camera should see a different subset of objects, use <code>renderMask</code> bits to separate them before the single render call.</p>
|
|
74
|
-
<h2 id="step-9-use-scissor-for-hard-splitmasking">Step 9: Use Scissor for Hard Split/Masking</h2>
|
|
75
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8; overflow-x: auto;" tabindex="0" data-language="js"><code><span class="line"><span style="color:#E1E4E8">leftTarget.scissor </span><span style="color:#F97583">=</span><span style="color:#F97583"> new</span><span style="color:#B392F0"> ViewRectangle</span><span style="color:#E1E4E8">();</span></span>
|
|
76
|
-
<span class="line"><span style="color:#E1E4E8">rightTarget.scissor </span><span style="color:#F97583">=</span><span style="color:#F97583"> new</span><span style="color:#B392F0"> ViewRectangle</span><span style="color:#E1E4E8">();</span></span>
|
|
77
|
-
<span class="line"></span>
|
|
78
|
-
<span class="line"><span style="color:#E1E4E8">leftTarget.scissor.offset.</span><span style="color:#B392F0">set</span><span style="color:#E1E4E8">(</span><span style="color:#79B8FF">0</span><span style="color:#E1E4E8">, </span><span style="color:#79B8FF">0</span><span style="color:#E1E4E8">);</span></span>
|
|
79
|
-
<span class="line"><span style="color:#E1E4E8">leftTarget.scissor.size.</span><span style="color:#B392F0">set</span><span style="color:#E1E4E8">(</span><span style="color:#79B8FF">0.5</span><span style="color:#E1E4E8">, </span><span style="color:#79B8FF">1</span><span style="color:#E1E4E8">);</span></span>
|
|
80
|
-
<span class="line"></span>
|
|
81
|
-
<span class="line"><span style="color:#E1E4E8">rightTarget.scissor.offset.</span><span style="color:#B392F0">set</span><span style="color:#E1E4E8">(</span><span style="color:#79B8FF">0.5</span><span style="color:#E1E4E8">, </span><span style="color:#79B8FF">0</span><span style="color:#E1E4E8">);</span></span>
|
|
82
|
-
<span class="line"><span style="color:#E1E4E8">rightTarget.scissor.size.</span><span style="color:#B392F0">set</span><span style="color:#E1E4E8">(</span><span style="color:#79B8FF">0.5</span><span style="color:#E1E4E8">, </span><span style="color:#79B8FF">1</span><span style="color:#E1E4E8">);</span></span></code></pre>
|
|
83
|
-
<p>Scissor restricts actual draw area, useful for editor layouts and split bars.</p>
|
|
84
|
-
<h2 id="resize-rule-for-multi-view-scenes">Resize Rule for Multi-View Scenes</h2>
|
|
85
|
-
<p>Keep canvas size and camera projection in sync on resize.
|
|
86
|
-
For split views, compute aspect per view region (not full canvas).</p>
|
|
87
|
-
<h2 id="reference-examples">Reference Examples</h2>
|
|
88
|
-
<ul>
|
|
89
|
-
<li><a href="/examples/rendertarget/basic_canvas">Basic Canvas Target</a></li>
|
|
90
|
-
<li><a href="/examples/rendertarget/image_target">Image Target</a></li>
|
|
91
|
-
<li><a href="/examples/rendertarget/split_screen">Split Screen</a></li>
|
|
92
|
-
<li><a href="/examples/rendertarget/multiple_views">Multiple Views</a></li>
|
|
93
|
-
<li><a href="/examples/rendertarget/split_view">Split View</a></li>
|
|
94
|
-
</ul>
|
|
95
|
-
</main> </div> <script type="module">var e=document.getElementById(`menu-toggle`);e?.addEventListener(`click`,()=>{let t=document.body.classList.toggle(`menu-open`);e.setAttribute(`aria-expanded`,t?`true`:`false`)});var t=document.getElementById(`site-sidebar`);if(t instanceof HTMLElement){let e=window.location.pathname.replace(/\/+$/,``)||`/`,n=`sidebar-scroll:${e===`/`?`/`:e.split(`/`)[1]||e}`,r=0,i=()=>{try{let e=sessionStorage.getItem(n);return e===null?null:Number.parseInt(e,10)}catch{return null}},a=()=>{try{sessionStorage.setItem(n,String(t.scrollTop))}catch{}r=0},o=()=>{r===0&&(r=window.requestAnimationFrame(a))},s=i();s!==null&&Number.isFinite(s)&&(t.scrollTop=s),t.addEventListener(`scroll`,o,{passive:!0}),window.addEventListener(`pagehide`,a),window.addEventListener(`beforeunload`,a)}</script></body> </html>
|
|
@@ -1,69 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html> <html lang="en"> <head><meta charset="UTF-8"><meta name="viewport" content="width=device-width"><meta name="generator" content="Astro v7.2.2"><title>Scene Graph and Transforms | chorama</title><style>.category-section[data-astro-cid-mzi2nk5r]+.category-section[data-astro-cid-mzi2nk5r]{margin-top:2rem}.category-section[data-astro-cid-mzi2nk5r] h2[data-astro-cid-mzi2nk5r]{margin-bottom:.75rem}.examples-grid[data-astro-cid-mzi2nk5r]{grid-template-columns:repeat(auto-fill,minmax(220px,1fr));gap:1rem;margin-top:1.5rem;display:grid}.example-card[data-astro-cid-mzi2nk5r]{aspect-ratio:4/3;border:1px solid var(--border);background:var(--surface-2);border-radius:0;text-decoration:none;display:block;position:relative;overflow:hidden}.example-card[data-astro-cid-mzi2nk5r] img[data-astro-cid-mzi2nk5r]{object-fit:cover;width:100%;height:100%;display:block}.example-card[data-astro-cid-mzi2nk5r] span[data-astro-cid-mzi2nk5r]{text-align:center;color:#fff;background:linear-gradient(#00000026,#000c);padding:.55rem .75rem;font-weight:700;position:absolute;bottom:0;left:0;right:0}.example-frame[data-astro-cid-mxkslj3q]{width:100%;margin-bottom:1.25rem;position:relative}.example-link[data-astro-cid-mxkslj3q]{z-index:1;color:var(--accent);background:#00000059;border-radius:0;padding:.2rem .5rem;font-weight:600;text-decoration:underline;position:absolute;top:7rem;left:50%;transform:translate(-50%)}.example-link[data-astro-cid-mxkslj3q]:hover{color:var(--accent-secondary)}.source-code[data-astro-cid-mxkslj3q]{outline:1px solid var(--border);outline-offset:0;border-radius:0;overflow:hidden}.example-preview[data-astro-cid-mxkslj3q]{border:1px solid var(--border);background:#fff;border-radius:0;width:100%;height:560px;margin:0 0 1.25rem;display:block}.source-code[data-astro-cid-mxkslj3q] .astro-code{border:0!important;border-radius:0!important}.source-code[data-astro-cid-mxkslj3q] pre{padding:10px;margin:0!important}
|
|
2
|
-
</style><link rel="stylesheet" href="/_astro/DocLayout.BsV7p0dY.css"></head> <body> <div class="shell"> <button class="menu-toggle" id="menu-toggle" type="button" aria-label="Toggle menu" aria-expanded="false" aria-controls="site-sidebar"> <span></span> <span></span> <span></span> </button> <aside id="site-sidebar" aria-label="Sidebar navigation"> <p class="tabs-title">Navigation</p> <div><ul class="tabs"><li class="tab-item"><details class="tab-group"><summary class="tab-toggle"><span>Introduction</span><span class="chevron">›</span></summary><ul class="tabs"><li class="tab-item"><a href="/#features">Features</a></li><li class="tab-item"><a href="/#who-this-is-for">Who This Is For</a></li><li class="tab-item"><a href="/#getting-started">Getting Started</a><ul class="subtabs" hidden><li class="tab-item"><a href="/#requirements">Requirements</a></li><li class="tab-item"><a href="/#install-dependencies">Install dependencies</a></li><li class="tab-item"><a href="/#build-library-bundles">Build library bundles</a></li><li class="tab-item"><a href="/#run-demos">Run demos</a></li></ul></li><li class="tab-item"><a href="/#core-usage-flow">Core Usage Flow</a></li></ul></details></li><li class="tab-item"><details class="tab-group" open><summary class="tab-toggle is-active"><span>Guide</span><span class="chevron">›</span></summary><ul class="tabs"><li class="tab-item"><a href="/guide">Overview</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide#who-this-guide-is-for">Who This Guide Is For</a></li><li class="tab-item"><a href="/guide#how-to-use-this-guide">How To Use This Guide</a></li><li class="tab-item"><a href="/guide#reading-order">Reading Order</a></li><li class="tab-item"><a href="/guide#core-flow">Core Flow</a></li></ul></li><li class="tab-item"><a href="/guide/installation">Installation</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/installation#npm">NPM</a></li><li class="tab-item"><a href="/guide/installation#cdn">CDN</a></li><li class="tab-item"><a href="/guide/installation#manual-installation">Manual Installation</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/installation#1-requirements">Requirements</a></li><li class="tab-item"><a href="/guide/installation#2-clone-the-repository-and-install-dependencies">Clone the repository and install dependencies</a></li><li class="tab-item"><a href="/guide/installation#3-build-the-library-files">Build the library files</a></li><li class="tab-item"><a href="/guide/installation#4-copy-files-to-your-project">Copy files to your project</a></li><li class="tab-item"><a href="/guide/installation#5-use-in-your-project">Use in your project</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/installation#esm-recommended">ESM (recommended)</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/installation#vite-viteconfigjs">Vite (vite.config.js)</a></li><li class="tab-item"><a href="/guide/installation#webpack-webpackconfigjs">Webpack (webpack.config.js)</a></li></ul></li><li class="tab-item"><a href="/guide/installation#plain-html-with-browser-import-maps-no-bundler">Plain HTML with browser import maps (no bundler)</a></li><li class="tab-item"><a href="/guide/installation#plain-html-with-script-tag-umd">Plain HTML with script tag (UMD)</a></li></ul></li></ul></li></ul></li><li class="tab-item"><a href="/guide/first-scene">First Scene</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/first-scene#what-you-will-build">What You Will Build</a></li><li class="tab-item"><a href="/guide/first-scene#before-you-start">Before You Start</a></li><li class="tab-item"><a href="/guide/first-scene#build-your-first-scene">Build Your first scene</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/first-scene#step-1-import-what-you-need">Step 1: Import what you need</a></li><li class="tab-item"><a href="/guide/first-scene#step-2-create-and-mount-a-canvas">Step 2: Create and mount a canvas</a></li><li class="tab-item"><a href="/guide/first-scene#step-3-create-device-and-render-target">Step 3: Create device and render target</a></li><li class="tab-item"><a href="/guide/first-scene#step-4-create-renderer-and-required-plugins">Step 4: Create renderer and required plugins</a></li><li class="tab-item"><a href="/guide/first-scene#step-5-create-and-position-a-camera">Step 5: Create and position a camera</a></li><li class="tab-item"><a href="/guide/first-scene#step-6-create-a-cube-object">Step 6: Create a cube object</a></li><li class="tab-item"><a href="/guide/first-scene#step-7-define-per-frame-rotation">Step 7: Define per-frame rotation</a></li><li class="tab-item"><a href="/guide/first-scene#step-8-add-resize-handling">Step 8: Add resize handling</a></li><li class="tab-item"><a href="/guide/first-scene#step-9-start-the-render-loop">Step 9: Start the render loop</a></li></ul></li><li class="tab-item"><a href="/guide/first-scene#what-you-can-try-next">What You Can Try Next</a></li><li class="tab-item"><a href="/guide/first-scene#reference-example">Reference Example</a></li></ul></li><li class="tab-item"><a href="/guide/camera-and-controls">Camera and Controls</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/camera-and-controls#what-you-will-add">What You Will Add</a></li><li class="tab-item"><a href="/guide/camera-and-controls#step-1-import-camera-apis">Step 1: Import Camera APIs</a></li><li class="tab-item"><a href="/guide/camera-and-controls#step-2-create-a-camera">Step 2: Create a Camera</a></li><li class="tab-item"><a href="/guide/camera-and-controls#step-3-configure-perspective-projection">Step 3: Configure Perspective Projection</a></li><li class="tab-item"><a href="/guide/camera-and-controls#step-4-add-orbit-controls">Step 4: Add Orbit Controls</a></li><li class="tab-item"><a href="/guide/camera-and-controls#step-5-update-controls-in-the-frame-loop">Step 5: Update Controls in the Frame Loop</a></li><li class="tab-item"><a href="/guide/camera-and-controls#switch-to-orthographic-projection">Switch to Orthographic Projection</a></li><li class="tab-item"><a href="/guide/camera-and-controls#reference-examples">Reference Examples</a></li></ul></li><li class="tab-item"><a href="/guide/materials-and-lighting">Materials and Lighting</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/materials-and-lighting#what-you-will-add">What You Will Add</a></li><li class="tab-item"><a href="/guide/materials-and-lighting#step-1-import-material-and-light-apis">Step 1: Import Material and Light APIs</a></li><li class="tab-item"><a href="/guide/materials-and-lighting#step-2-pick-a-material-model">Step 2: Pick a Material Model</a></li><li class="tab-item"><a href="/guide/materials-and-lighting#step-3-apply-the-material-to-your-mesh-object">Step 3: Apply the Material to Your Mesh Object</a></li><li class="tab-item"><a href="/guide/materials-and-lighting#step-4-enable-the-lighting-pipeline-in-the-renderer">Step 4: Enable the Lighting Pipeline in the Renderer</a></li><li class="tab-item"><a href="/guide/materials-and-lighting#step-5-add-ambient-light">Step 5: Add Ambient Light</a></li><li class="tab-item"><a href="/guide/materials-and-lighting#step-6-add-a-directional-light">Step 6: Add a Directional Light</a></li><li class="tab-item"><a href="/guide/materials-and-lighting#step-7-render-with-object-lights-and-camera">Step 7: Render with Object, Lights, and Camera</a></li><li class="tab-item"><a href="/guide/materials-and-lighting#step-8-animate-and-keep-scene-responsive">Step 8: Animate and Keep Scene Responsive</a></li><li class="tab-item"><a href="/guide/materials-and-lighting#switching-between-material-types">Switching Between Material Types</a></li><li class="tab-item"><a href="/guide/materials-and-lighting#reference-examples">Reference Examples</a></li></ul></li><li class="tab-item"><a href="/guide/textures-and-assets">What You Will Add</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/textures-and-assets#what-you-will-add">What You Will Add</a></li><li class="tab-item"><a href="/guide/textures-and-assets#step-1-import-loaders">Step 1: Import Loaders</a></li><li class="tab-item"><a href="/guide/textures-and-assets#step-2-load-a-texture">Step 2: Load a Texture</a></li><li class="tab-item"><a href="/guide/textures-and-assets#step-3-apply-the-texture-to-a-material">Step 3: Apply the Texture to a Material</a></li><li class="tab-item"><a href="/guide/textures-and-assets#step-4-load-an-obj-model">Step 4: Load an OBJ Model</a></li><li class="tab-item"><a href="/guide/textures-and-assets#step-5-optionally-patch-imported-obj-materials">Step 5: Optionally Patch Imported OBJ Materials</a></li><li class="tab-item"><a href="/guide/textures-and-assets#step-6-load-a-gltf-scene">Step 6: Load a glTF Scene</a></li><li class="tab-item"><a href="/guide/textures-and-assets#step-7-render-streaming-assets-safely">Step 7: Render Streaming Assets Safely</a></li><li class="tab-item"><a href="/guide/textures-and-assets#path-rules-that-prevent-most-loading-errors">Path Rules That Prevent Most Loading Errors</a></li><li class="tab-item"><a href="/guide/textures-and-assets#reference-examples">Reference Examples</a></li></ul></li><li class="tab-item"><a href="/guide/render-targets-and-views">Render Targets and Views</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/render-targets-and-views#what-you-will-add">What You Will Add</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#step-1-import-render-target-apis">Step 1: Import Render Target APIs</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#step-2-create-a-canvas-target-most-common">Step 2: Create a Canvas Target (Most Common)</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#step-3-render-a-scene-to-the-canvas-target">Step 3: Render a Scene to the Canvas Target</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#step-4-create-an-offscreen-image-target">Step 4: Create an Offscreen Image Target</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#step-5-render-offscreen-with-a-dedicated-camera">Step 5: Render Offscreen with a Dedicated Camera</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#step-6-use-offscreen-output-as-a-texture">Step 6: Use Offscreen Output as a Texture</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#step-7-split-canvas-with-viewports">Step 7: Split Canvas with Viewports</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#step-8-bind-cameras-to-each-view-and-render-once">Step 8: Bind Cameras to Each View and Render Once</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#step-9-use-scissor-for-hard-splitmasking">Step 9: Use Scissor for Hard Split/Masking</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#resize-rule-for-multi-view-scenes">Resize Rule for Multi-View Scenes</a></li><li class="tab-item"><a href="/guide/render-targets-and-views#reference-examples">Reference Examples</a></li></ul></li><li class="tab-item"><a href="/guide/scene-graph-and-transforms" class="is-active">Scene Graph and Transforms</a><ul class="subtabs"><li class="tab-item"><a href="/guide/scene-graph-and-transforms#what-you-will-add">What You Will Add</a></li><li class="tab-item"><a href="/guide/scene-graph-and-transforms#step-1-import-what-you-need">Step 1: Import What You Need</a></li><li class="tab-item"><a href="/guide/scene-graph-and-transforms#step-2-create-parent-and-child-nodes">Step 2: Create Parent and Child Nodes</a></li><li class="tab-item"><a href="/guide/scene-graph-and-transforms#step-3-build-the-hierarchy">Step 3: Build the Hierarchy</a></li><li class="tab-item"><a href="/guide/scene-graph-and-transforms#step-4-set-local-transforms">Step 4: Set Local Transforms</a></li><li class="tab-item"><a href="/guide/scene-graph-and-transforms#step-5-animate-the-parent">Step 5: Animate the Parent</a></li><li class="tab-item"><a href="/guide/scene-graph-and-transforms#step-6-render-the-hierarchy">Step 6: Render the Hierarchy</a></li><li class="tab-item"><a href="/guide/scene-graph-and-transforms#traverse-the-graph-for-bulk-operations">Traverse the Graph for Bulk Operations</a></li><li class="tab-item"><a href="/guide/scene-graph-and-transforms#reparent-safely">Reparent Safely</a></li><li class="tab-item"><a href="/guide/scene-graph-and-transforms#reference-examples">Reference Examples</a></li></ul></li><li class="tab-item"><a href="/guide/plugins-and-render-pipeline">Plugins and Render Pipeline</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/plugins-and-render-pipeline#what-you-will-add">What You Will Add</a></li><li class="tab-item"><a href="/guide/plugins-and-render-pipeline#step-1-import-core-renderer-and-plugins">Step 1: Import Core Renderer and Plugins</a></li><li class="tab-item"><a href="/guide/plugins-and-render-pipeline#step-2-build-a-minimal-plugin-stack">Step 2: Build a Minimal Plugin Stack</a></li><li class="tab-item"><a href="/guide/plugins-and-render-pipeline#step-3-add-lighting-support">Step 3: Add Lighting Support</a></li><li class="tab-item"><a href="/guide/plugins-and-render-pipeline#step-4-add-shadows-and-skybox-when-needed">Step 4: Add Shadows and Skybox When Needed</a></li><li class="tab-item"><a href="/guide/plugins-and-render-pipeline#step-5-render-as-usual">Step 5: Render as Usual</a></li><li class="tab-item"><a href="/guide/plugins-and-render-pipeline#what-happens-during-render">What Happens During render()</a></li><li class="tab-item"><a href="/guide/plugins-and-render-pipeline#plugin-roles">Plugin Roles</a></li><li class="tab-item"><a href="/guide/plugins-and-render-pipeline#create-a-custom-plugin">Create a Custom Plugin</a></li></ul></li><li class="tab-item"><a href="/guide/api-map">API Map</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/api-map#quick-import-example">Quick Import Example</a></li><li class="tab-item"><a href="/guide/api-map#rendering-core">Rendering Core</a></li><li class="tab-item"><a href="/guide/api-map#scene-objects">Scene Objects</a></li><li class="tab-item"><a href="/guide/api-map#materials">Materials</a></li><li class="tab-item"><a href="/guide/api-map#lighting">Lighting</a></li><li class="tab-item"><a href="/guide/api-map#geometry-and-mesh">Geometry and Mesh</a></li><li class="tab-item"><a href="/guide/api-map#camera-and-control">Camera and Control</a></li><li class="tab-item"><a href="/guide/api-map#assets-and-textures">Assets and Textures</a></li><li class="tab-item"><a href="/guide/api-map#render-targets">Render Targets</a></li><li class="tab-item"><a href="/guide/api-map#plugins">Plugins</a></li></ul></li><li class="tab-item"><a href="/guide/troubleshooting">Troubleshooting</a><ul class="subtabs" hidden><li class="tab-item"><a href="/guide/troubleshooting#blank-canvas">Blank Canvas</a></li><li class="tab-item"><a href="/guide/troubleshooting#object-is-black-or-unlit">Object Is Black or Unlit</a></li><li class="tab-item"><a href="/guide/troubleshooting#distorted-aspect-ratio">Distorted Aspect Ratio</a></li><li class="tab-item"><a href="/guide/troubleshooting#missing-textures-or-models">Missing Textures or Models</a></li><li class="tab-item"><a href="/guide/troubleshooting#shadows-not-visible">Shadows Not Visible</a></li></ul></li></ul></details></li><li class="tab-item"><a href="/examples">Examples</a></li></ul></div> </aside> <main> <h1 id="scene-graph-and-transforms">Scene Graph and Transforms</h1>
|
|
3
|
-
<p>This guide assumes you already have a running scene from <a href="/guide/first-scene">First Scene</a>.
|
|
4
|
-
Here, we focus on parent-child relationships and transform behavior.</p>
|
|
5
|
-
<h2 id="what-you-will-add">What You Will Add</h2>
|
|
6
|
-
<ul>
|
|
7
|
-
<li>a parent object</li>
|
|
8
|
-
<li>one or more child objects</li>
|
|
9
|
-
<li>local transforms per node</li>
|
|
10
|
-
<li>frame updates that propagate through hierarchy</li>
|
|
11
|
-
</ul>
|
|
12
|
-
<h2 id="step-1-import-what-you-need">Step 1: Import What You Need</h2>
|
|
13
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8; overflow-x: auto;" tabindex="0" data-language="js"><code><span class="line"><span style="color:#F97583">import</span><span style="color:#E1E4E8"> { Object3D, MeshMaterial3D, Quaternion } </span><span style="color:#F97583">from</span><span style="color:#9ECBFF"> "chorama"</span><span style="color:#E1E4E8">;</span></span></code></pre>
|
|
14
|
-
<p>Use <code>Object3D</code> for grouping and transform hierarchy.
|
|
15
|
-
Use <code>MeshMaterial3D</code> when the node should be renderable.</p>
|
|
16
|
-
<h2 id="step-2-create-parent-and-child-nodes">Step 2: Create Parent and Child Nodes</h2>
|
|
17
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8; overflow-x: auto;" tabindex="0" data-language="js"><code><span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> root</span><span style="color:#F97583"> =</span><span style="color:#F97583"> new</span><span style="color:#B392F0"> Object3D</span><span style="color:#E1E4E8">();</span></span>
|
|
18
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> parent</span><span style="color:#F97583"> =</span><span style="color:#F97583"> new</span><span style="color:#B392F0"> MeshMaterial3D</span><span style="color:#E1E4E8">(mesh, material);</span></span>
|
|
19
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> child</span><span style="color:#F97583"> =</span><span style="color:#F97583"> new</span><span style="color:#B392F0"> MeshMaterial3D</span><span style="color:#E1E4E8">(mesh, material);</span></span></code></pre>
|
|
20
|
-
<p><code>root</code> is a logical container.
|
|
21
|
-
<code>parent</code> and <code>child</code> are visible mesh nodes.</p>
|
|
22
|
-
<h2 id="step-3-build-the-hierarchy">Step 3: Build the Hierarchy</h2>
|
|
23
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8; overflow-x: auto;" tabindex="0" data-language="js"><code><span class="line"><span style="color:#E1E4E8">root.</span><span style="color:#B392F0">add</span><span style="color:#E1E4E8">(parent);</span></span>
|
|
24
|
-
<span class="line"><span style="color:#E1E4E8">parent.</span><span style="color:#B392F0">add</span><span style="color:#E1E4E8">(child);</span></span></code></pre>
|
|
25
|
-
<p>Now <code>child</code> inherits <code>parent</code> transform changes.
|
|
26
|
-
If parent rotates or moves, child follows automatically.</p>
|
|
27
|
-
<h2 id="step-4-set-local-transforms">Step 4: Set Local Transforms</h2>
|
|
28
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8; overflow-x: auto;" tabindex="0" data-language="js"><code><span class="line"><span style="color:#E1E4E8">parent.transform.position.x </span><span style="color:#F97583">=</span><span style="color:#79B8FF"> 0</span><span style="color:#E1E4E8">;</span></span>
|
|
29
|
-
<span class="line"><span style="color:#E1E4E8">child.transform.position.x </span><span style="color:#F97583">=</span><span style="color:#79B8FF"> 1</span><span style="color:#E1E4E8">;</span></span></code></pre>
|
|
30
|
-
<p><code>child.transform.position.x = 1</code> means “one unit from parent”, not world origin.
|
|
31
|
-
Think in local space first when building hierarchies.</p>
|
|
32
|
-
<h2 id="step-5-animate-the-parent">Step 5: Animate the Parent</h2>
|
|
33
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8; overflow-x: auto;" tabindex="0" data-language="js"><code><span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> stepRotation</span><span style="color:#F97583"> =</span><span style="color:#E1E4E8"> Quaternion.</span><span style="color:#B392F0">fromEuler</span><span style="color:#E1E4E8">(</span><span style="color:#79B8FF">0.01</span><span style="color:#E1E4E8">, </span><span style="color:#79B8FF">0.01</span><span style="color:#E1E4E8">, </span><span style="color:#79B8FF">0.0</span><span style="color:#E1E4E8">);</span></span>
|
|
34
|
-
<span class="line"></span>
|
|
35
|
-
<span class="line"><span style="color:#F97583">function</span><span style="color:#B392F0"> updateScene</span><span style="color:#E1E4E8">() {</span></span>
|
|
36
|
-
<span class="line"><span style="color:#E1E4E8"> parent.transform.orientation.</span><span style="color:#B392F0">multiply</span><span style="color:#E1E4E8">(stepRotation);</span></span>
|
|
37
|
-
<span class="line"><span style="color:#E1E4E8">}</span></span></code></pre>
|
|
38
|
-
<p>Rotating the parent creates orbital motion for the child due to inheritance.
|
|
39
|
-
This is the simplest way to verify propagation is working.</p>
|
|
40
|
-
<h2 id="step-6-render-the-hierarchy">Step 6: Render the Hierarchy</h2>
|
|
41
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8; overflow-x: auto;" tabindex="0" data-language="js"><code><span class="line"><span style="color:#F97583">function</span><span style="color:#B392F0"> frame</span><span style="color:#E1E4E8">() {</span></span>
|
|
42
|
-
<span class="line"><span style="color:#B392F0"> updateScene</span><span style="color:#E1E4E8">();</span></span>
|
|
43
|
-
<span class="line"><span style="color:#E1E4E8"> renderer.</span><span style="color:#B392F0">render</span><span style="color:#E1E4E8">([root, camera], device);</span></span>
|
|
44
|
-
<span class="line"><span style="color:#B392F0"> requestAnimationFrame</span><span style="color:#E1E4E8">(frame);</span></span>
|
|
45
|
-
<span class="line"><span style="color:#E1E4E8">}</span></span>
|
|
46
|
-
<span class="line"></span>
|
|
47
|
-
<span class="line"><span style="color:#B392F0">requestAnimationFrame</span><span style="color:#E1E4E8">(frame);</span></span></code></pre>
|
|
48
|
-
<p>You can render the root and let traversal include descendants.
|
|
49
|
-
You do not need to pass every child separately if already attached.</p>
|
|
50
|
-
<h2 id="traverse-the-graph-for-bulk-operations">Traverse the Graph for Bulk Operations</h2>
|
|
51
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8; overflow-x: auto;" tabindex="0" data-language="js"><code><span class="line"><span style="color:#E1E4E8">root.</span><span style="color:#B392F0">traverseDFS</span><span style="color:#E1E4E8">((</span><span style="color:#FFAB70">node</span><span style="color:#E1E4E8">) </span><span style="color:#F97583">=></span><span style="color:#E1E4E8"> {</span></span>
|
|
52
|
-
<span class="line"><span style="color:#6A737D"> // Example: debug flags, tagging, filtering, or custom updates</span></span>
|
|
53
|
-
<span class="line"><span style="color:#F97583"> return</span><span style="color:#79B8FF"> true</span><span style="color:#E1E4E8">;</span></span>
|
|
54
|
-
<span class="line"><span style="color:#E1E4E8">});</span></span></code></pre>
|
|
55
|
-
<p>Use traversal when you need one operation across many descendants.
|
|
56
|
-
Return <code>true</code> to continue deeper traversal.</p>
|
|
57
|
-
<h2 id="reparent-safely">Reparent Safely</h2>
|
|
58
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8; overflow-x: auto;" tabindex="0" data-language="js"><code><span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> newParent</span><span style="color:#F97583"> =</span><span style="color:#F97583"> new</span><span style="color:#B392F0"> Object3D</span><span style="color:#E1E4E8">();</span></span>
|
|
59
|
-
<span class="line"><span style="color:#E1E4E8">root.</span><span style="color:#B392F0">add</span><span style="color:#E1E4E8">(newParent);</span></span>
|
|
60
|
-
<span class="line"><span style="color:#E1E4E8">newParent.</span><span style="color:#B392F0">add</span><span style="color:#E1E4E8">(child);</span></span>
|
|
61
|
-
<span class="line"><span style="color:#E1E4E8">parent.</span><span style="color:#B392F0">remove</span><span style="color:#E1E4E8">(child);</span></span></code></pre>
|
|
62
|
-
<p>Reparenting changes which transform chain affects the object.</p>
|
|
63
|
-
<h2 id="reference-examples">Reference Examples</h2>
|
|
64
|
-
<ul>
|
|
65
|
-
<li><a href="/examples/transform/propagation">Transform Propagation</a></li>
|
|
66
|
-
<li><a href="/examples/mesh/skinning">Skinning</a></li>
|
|
67
|
-
</ul>
|
|
68
|
-
<p>After this works, continue with <a href="/guide/render-targets-and-views">Render Targets and Views</a></p>
|
|
69
|
-
</main> </div> <script type="module">var e=document.getElementById(`menu-toggle`);e?.addEventListener(`click`,()=>{let t=document.body.classList.toggle(`menu-open`);e.setAttribute(`aria-expanded`,t?`true`:`false`)});var t=document.getElementById(`site-sidebar`);if(t instanceof HTMLElement){let e=window.location.pathname.replace(/\/+$/,``)||`/`,n=`sidebar-scroll:${e===`/`?`/`:e.split(`/`)[1]||e}`,r=0,i=()=>{try{let e=sessionStorage.getItem(n);return e===null?null:Number.parseInt(e,10)}catch{return null}},a=()=>{try{sessionStorage.setItem(n,String(t.scrollTop))}catch{}r=0},o=()=>{r===0&&(r=window.requestAnimationFrame(a))},s=i();s!==null&&Number.isFinite(s)&&(t.scrollTop=s),t.addEventListener(`scroll`,o,{passive:!0}),window.addEventListener(`pagehide`,a),window.addEventListener(`beforeunload`,a)}</script></body> </html>
|