Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs:: Add documentation for ClippingGroup. #29833

Merged
merged 3 commits into from
Nov 12, 2024

Conversation

aardgoose
Copy link
Contributor

Add a first draft documentation page for ClippingGroup.

Should ClippingGroup (and BundleGroup) be moved to src/objects with other Object3D subclasses?

Can some markup/labelling be applied to indicate that a feature is WebGPURenderer only.?

@Mugen87
Copy link
Collaborator

Mugen87 commented Nov 7, 2024

Should ClippingGroup (and BundleGroup) be moved to src/objects with other Object3D subclasses?

Yes, that sounds good to me.

Can some markup/labelling be applied to indicate that a feature is WebGPURenderer only.?

Until we find a solution, you can use a simple note under the description. We've used this approach for WebGL 2 only features as well. Maybe:

Note: ClippingGroup is only supported with WebGPURenderer.

Copy link

github-actions bot commented Nov 7, 2024

📦 Bundle size

Full ESM build, minified and gzipped.

Before After Diff
WebGL 339.37
79.06
339.37
79.06
+0 B
+0 B
WebGPU 477.43
132.37
477.43
132.37
+0 B
-4 B
WebGPU Nodes 476.73
132.2
476.9
132.25
+171 B
+46 B

🌳 Bundle size after tree-shaking

Minimal build including a renderer, camera, empty scene, and dependencies.

Before After Diff
WebGL 464.82
112.02
464.82
112.02
+0 B
+0 B
WebGPU 546.47
148.04
546.47
148.04
+0 B
+0 B
WebGPU Nodes 502.35
137.74
502.35
137.74
+0 B
+0 B

@Mugen87 Mugen87 added this to the r171 milestone Nov 7, 2024
@Mugen87 Mugen87 changed the title Docs:: Add documentation for ClippingGroup() Docs:: Add documentation for ClippingGroup. Nov 12, 2024
@Mugen87 Mugen87 merged commit ed9f5a1 into mrdoob:dev Nov 12, 2024
12 checks passed
@aardgoose aardgoose deleted the doc-clipping-group branch November 15, 2024 11:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants