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

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from

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 692.22
171.45
692.22
171.45
+0 B
+0 B
WebGPU 825.22
222.85
825.22
222.84
+0 B
-4 B
WebGPU Nodes 824.33
222.64
824.5
222.69
+171 B
+47 B

🌳 Bundle size after tree-shaking

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

Before After Diff
WebGL 464.58
112.26
464.58
112.26
+0 B
+0 B
WebGPU 545.43
147.71
545.43
147.71
+0 B
+0 B
WebGPU Nodes 501.37
137.44
501.37
137.44
+0 B
+0 B

@Mugen87 Mugen87 added this to the r171 milestone Nov 7, 2024
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